From 497afccb07164373e0de6639e754d7d691f1926f Mon Sep 17 00:00:00 2001 From: Fabien Costantini Date: Tue, 14 Oct 2008 22:12:25 +0000 Subject: Doxygen pdf man: First version added in documentation/fltk.pdf, old doc removed, images, dox files moved to a new src directory. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6431 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/Fl_Choice.html | 88 -------------------------------------------- 1 file changed, 88 deletions(-) delete mode 100644 documentation/Fl_Choice.html (limited to 'documentation/Fl_Choice.html') diff --git a/documentation/Fl_Choice.html b/documentation/Fl_Choice.html deleted file mode 100644 index c4c167637..000000000 --- a/documentation/Fl_Choice.html +++ /dev/null @@ -1,88 +0,0 @@ - - - Fl_Choice - - - -

class Fl_Choice

-
-

Class Hierarchy

- -

Include Files

- -

Description

- This is a button that when pushed pops up a menu (or hierarchy of -menus) defined by an array of -Fl_Menu_Item objects. Motif calls this an OptionButton. -

The only difference between this and a -Fl_Menu_Button is that the name of the most recent chosen -menu item is displayed inside the box, while the label is displayed -outside the box. However, since the use of this is most often to -control a single variable rather than do individual callbacks, some of -the Fl_Menu_Button methods are redescribed here in those -terms.

-

When the user picks an item off the menu the value() -is set to that item and then the item's callback is done with -the menu_button as the Fl_Widget* argument. If the -item does not have a callback the menu_button's callback is done -instead.

-

All three mouse buttons pop up the menu. The Forms behavior of the -first two buttons to increment/decrement the choice is not implemented. - This could be added with a subclass, however.

-

The menu will also pop up in response to shortcuts indicated by -putting a '&' character in the label(). See -Fl_Button for a description of this.

-

Typing the shortcut() of any of the items will do exactly -the same as when you pick the item with the mouse. The '&' character in -item names are only looked at when the menu is popped up, however.

-

Fl_Choice widget.

-

Methods

- -

Fl_Choice::Fl_Choice(int x, int y, int -w, int h, const char *label = 0)

- Creates a new Fl_Choice widget using the given position, -size, and label string. The default boxtype is FL_UP_BOX. -

The constructor sets menu() to NULL. See -Fl_Menu_ for the methods to set or change the menu.

-

virtual Fl_Choice::~Fl_Choice()

- The destructor removes the Fl_Choice widget and all of its -menu items. -

int Fl_Choice::value() const -
int Fl_Choice::value(int) -
int Fl_Choice::value(const Fl_Menu *)

- The value is the index into the Fl_Menu array of the last -item chosen by the user. It is zero initially. You can set it as an -integer, or set it with a pointer to a menu item. The set routines -return non-zero if the new value is different than the old one. - Changing it causes a redraw(). -

int Fl_Widget::changed() const

- This value is true if the user picks a different value. It is -turned off by value() and just before doing a callback (the -callback can turn it back on if desired). -

void Fl_Widget::set_changed()

- This method sets the changed() flag. -

void Fl_Widget::clear_changed()

- This method clears the changed() flag. -

Fl_Boxtype Fl_Choice::down_box() const -
void Fl_Choice::down_box(Fl_Boxtype b)

- The first form gets the current down box, which is used when the menu -is popped up. The default down box type is FL_DOWN_BOX The -second form sets the current down box type to b. -- cgit v1.2.3