4 * Copyright 1996 Alejandro Aguilar Sierra
5 * This file is part of LyX, the document processor.
6 * Licence details can be found in the file COPYING.
8 * \author Alejandro Aguilar Sierra
10 * Full author contact details are available in file CREDITS
13 /* A combination of two objects (a button and a browser) is encapsulated to
14 * get a combobox-like object. All XForms functions are hidden.
18 * 2/06/1996, Alejandro Aguilar Sierra
21 * 4/06/1996, Alejandro Aguilar Sierra
22 * Added droplist mode (a button with a black down arrow at right)
23 * and support for middle and right buttons, as XForms choice object.
30 #include FORMS_H_LOCATION
46 /// callback prototype
47 typedef void (*FL_COMBO_CB) (int, void *, Combox *);
48 /// pre post prototype
49 typedef void (*FL_COMBO_PRE_POST) ();
56 explicit Combox(combox_type t = FL_COMBOX_NORMAL);
60 /** To add this object to a form. Note that there are two heights
61 * for normal (button) and expanded (browser) mode each.
63 void add(int x, int y, int w, int hmin, int hmax);
65 /// Add lines. Same as for fl_browser object
66 void addline(string const &);
67 /// Add lines. Same as for fl_browser object
68 void addto(string const &);
70 /// Returns the selected item
73 /// Returns a pointer to the selected line of text
74 string const getline() const;
76 /// Select an arbitrary item
79 bool select(string const &);
81 /// Clear all the list
84 /// Is the combox cleared (empty)
85 bool empty() const { return is_empty; }
87 /// Remove the objects from the form they are in.
91 * Assign a callback to this object. The callback should be a void
92 * function with a int, a void pointer, and a Combox pointer as
95 void setcallback(FL_COMBO_CB, void *);
98 void setpre(FL_COMBO_PRE_POST);
100 void setpost(FL_COMBO_PRE_POST);
102 /// XForms attributes
103 void resize(unsigned);
105 void gravity(unsigned, unsigned);
111 void shortcut(string const &, int);
117 static void combo_cb(FL_OBJECT *, long);
119 static void input_cb(FL_OBJECT *, long);
121 static int peek_event(FL_FORM *, void *);
123 /// At least Hide should not be public
124 void hide(int who = 0);
139 FL_COMBO_CB callback;
143 FL_COMBO_PRE_POST _pre;
145 FL_COMBO_PRE_POST _post;
156 //----------------- Inline methods ---------------------------
159 void Combox::addto(string const & text)
162 fl_addto_browser(browser, text.c_str());
169 void Combox::resize(unsigned r)
171 fl_set_object_resize(button, r);
172 if (label!= button) fl_set_object_resize(label, r);
177 void Combox::gravity(unsigned g1, unsigned g2)
179 fl_set_object_gravity(button, g1, g2);
180 if (label!= button) fl_set_object_gravity(label, g1, g2);
185 void Combox::shortcut(string const & s, int i)
188 fl_set_object_shortcut(button, s.c_str(), i);
193 void Combox::setcallback(FL_COMBO_CB cb, void * a = 0)
201 void Combox::setpre(FL_COMBO_PRE_POST cb)
208 void Combox::setpost(FL_COMBO_PRE_POST cb)
215 int Combox::get() const
222 string const Combox::getline() const
224 if (type == FL_COMBOX_INPUT)
225 return fl_get_input(label);
227 return (browser && sel > 0) ?
228 string(fl_get_browser_line(browser, sel)) : string();