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.
33 #include FORMS_H_LOCATION
49 /// callback prototype
50 typedef void (*FL_COMBO_CB) (int, void *, Combox *);
51 /// pre post prototype
52 typedef void (*FL_COMBO_PRE_POST) ();
59 explicit Combox(combox_type t = FL_COMBOX_NORMAL);
63 /** To add this object to a form. Note that there are two heights
64 for normal (button) and expanded (browser) mode each.
65 The optional tabfolder arguments are needed to overcome an
66 xforms bug when repositioning a combox in a tab folder.
67 tabfolder1_ is the folder holding the combox.
68 If using nested tabfolders, tabfolder2_ is the "base" folder
71 void add(int x, int y, int w, int hmin, int hmax,
72 FL_OBJECT * tabfolder1_ = 0, FL_OBJECT * tabfolder2_ = 0);
74 /// Add lines. Same as for fl_browser object
75 void addline(string const &);
76 /// Add lines. Same as for fl_browser object
77 void addto(string const &);
79 /// Returns the selected item
82 /// Returns a pointer to the selected line of text
83 string const getline() const;
85 /// Select an arbitrary item
88 bool select(string const &);
90 /// Clear all the list
93 /// Is the combox cleared (empty)
94 bool empty() const { return is_empty; }
96 /// Remove the objects from the form they are in.
100 * Assign a callback to this object. The callback should be a void
101 * function with a int, a void pointer, and a Combox pointer as
104 void setcallback(FL_COMBO_CB, void *);
107 void setpre(FL_COMBO_PRE_POST);
109 void setpost(FL_COMBO_PRE_POST);
111 /// XForms attributes
112 void resize(unsigned);
114 void gravity(unsigned, unsigned);
120 void shortcut(string const &, int);
126 static void combo_cb(FL_OBJECT *, long);
128 static void input_cb(FL_OBJECT *, long);
130 static int peek_event(FL_FORM *, void *);
132 /// At least Hide should not be public
133 void hide(int who = 0);
148 FL_COMBO_CB callback;
152 FL_COMBO_PRE_POST _pre;
154 FL_COMBO_PRE_POST _post;
162 FL_OBJECT * tabfolder1;
164 FL_OBJECT * tabfolder2;
169 //----------------- Inline methods ---------------------------
172 void Combox::addto(string const & text)
175 fl_addto_browser(browser, text.c_str());
182 void Combox::resize(unsigned r)
184 fl_set_object_resize(button, r);
185 if (label!= button) fl_set_object_resize(label, r);
190 void Combox::gravity(unsigned g1, unsigned g2)
192 fl_set_object_gravity(button, g1, g2);
193 if (label!= button) fl_set_object_gravity(label, g1, g2);
198 void Combox::shortcut(string const & s, int i)
201 fl_set_object_shortcut(button, s.c_str(), i);
206 void Combox::setcallback(FL_COMBO_CB cb, void * a = 0)
214 void Combox::setpre(FL_COMBO_PRE_POST cb)
221 void Combox::setpost(FL_COMBO_PRE_POST cb)
228 int Combox::get() const
235 string const Combox::getline() const
237 if (type == FL_COMBOX_INPUT)
238 return fl_get_input(label);
240 return (browser && sel > 0) ?
241 string(fl_get_browser_line(browser, sel)) : string();