X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Ffrontends%2Fxforms%2Fcombox.h;h=abdbcda638be2e2dd725626087a48eebeb02d099;hb=37e82a546392d43f787826b85481a11f2a27af15;hp=eda47bb4cdd5ff153004f6f1ef4d7d1dadbb4b55;hpb=63420525764fc687def947171385c1379ac45c9c;p=lyx.git diff --git a/src/frontends/xforms/combox.h b/src/frontends/xforms/combox.h index eda47bb4cd..abdbcda638 100644 --- a/src/frontends/xforms/combox.h +++ b/src/frontends/xforms/combox.h @@ -5,7 +5,7 @@ * * \author Angus Leeming * - * Full author contact details are available in file CREDITS + * Full author contact details are available in file CREDITS. * * A combination of two objects (a button and a browser) is encapsulated to * get a combobox-like object. @@ -14,6 +14,8 @@ #ifndef FL_COMBOX_H #define FL_COMBOX_H +#include "lyx_forms.h" + #if defined(__cplusplus) extern "C" { @@ -39,10 +41,13 @@ typedef enum { /** A function to create a combox widget. * \param type is, as yet, unused. there is only one type of combox. - * \param x, \param y: the x,y coordinates of the upper left hand corner - * of the widget, relative to the parent form'd origin. - * \param w, \param h: the widget's dimensions. - * \param label: the widget's label as it appears on the GUI. + * \param x the x coordinate of the upper left hand corner of the widget, + * relative to the parent form's origin. + * \param y the y coordinate of the upper left hand corner of the widget, + * relative to the parent form's origin. + * \param w the widget's width + * \param h the widget's height + * \param label the widget's label as it appears on the GUI. */ FL_EXPORT FL_OBJECT * fl_create_combox(FL_COMBOX_TYPE type, @@ -58,45 +63,55 @@ fl_add_combox(FL_COMBOX_TYPE type, char const * label); /** The combox browser has a default height of 100 pixels. Adjust to suit. */ -FL_EXPORT void fl_set_combox_browser_height(FL_OBJECT * ob, int bh); +FL_EXPORT void +fl_set_combox_browser_height(FL_OBJECT * ob, int bh); /** The browser will be displayed either below or above the button, - * dependent upon \param position. + * dependent upon \c position. */ -FL_EXPORT void fl_set_combox_position(FL_OBJECT * ob, - FL_COMBOX_POSITION position); +FL_EXPORT void +fl_set_combox_position(FL_OBJECT * ob, FL_COMBOX_POSITION position); -/** Empty the browser and the combox, \param ob. */ -FL_EXPORT void fl_clear_combox(FL_OBJECT * ob); +/** Empty the browser and the combox. */ +FL_EXPORT void +fl_clear_combox(FL_OBJECT * ob); -/** Add a line to the combox browser.*/ -FL_EXPORT void fl_addto_combox(FL_OBJECT * ob, char const * text); +/** Add a line to the combox browser. */ +FL_EXPORT void +fl_addto_combox(FL_OBJECT * ob, char const * text); -/** Set the combox to return line \param choice of the combox browser. */ -FL_EXPORT void fl_set_combox(FL_OBJECT * ob, int choice); +/** Set the combox to return line \c choice of the combox browser. */ +FL_EXPORT void +fl_set_combox(FL_OBJECT * ob, int choice); /** \return the currently selected line of the combox browser. */ -FL_EXPORT int fl_get_combox(FL_OBJECT * ob); +FL_EXPORT int +fl_get_combox(FL_OBJECT * ob); /** \return the contents of the combox. * (Also the contents of currently selected line of the combox browser.) */ -FL_EXPORT char const * fl_get_combox_text(FL_OBJECT * ob); +FL_EXPORT char const * +fl_get_combox_text(FL_OBJECT * ob); -/** \return the contents of \param line of the combox browser. */ -FL_EXPORT char const * fl_get_combox_line(FL_OBJECT * ob, int line); +/** \return the contents of \c line of the combox browser. */ +FL_EXPORT char const * +fl_get_combox_line(FL_OBJECT * ob, int line); /** \return the number of items in the combox browser. */ -FL_EXPORT int fl_get_combox_maxitems(FL_OBJECT * ob); +FL_EXPORT int +fl_get_combox_maxitems(FL_OBJECT * ob); /** Show the browser */ -void fl_show_combox_browser(FL_OBJECT * ob); +FL_EXPORT void +fl_show_combox_browser(FL_OBJECT * ob); /** Hide the browser */ -void fl_hide_combox_browser(FL_OBJECT * ob); +FL_EXPORT void +fl_hide_combox_browser(FL_OBJECT * ob); #if defined(__cplusplus) } #endif -#endif +#endif /* NOT FL_COMBOX_H */