From 09daf20b81cdae78772f07c0af22a571d7cc73eb Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Thu, 29 Nov 2001 19:24:00 +0000 Subject: Documentation updates galore (up to chapter 7, still need to do chapter 8 and 9, tweek the appendices, and recapture the screenshots...) git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@1786 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/Fl_Menu_.html | 50 ++++++++++++++++++++++----------------------- 1 file changed, 25 insertions(+), 25 deletions(-) (limited to 'documentation/Fl_Menu_.html') diff --git a/documentation/Fl_Menu_.html b/documentation/Fl_Menu_.html index ba6ad06dd..bc34198f6 100644 --- a/documentation/Fl_Menu_.html +++ b/documentation/Fl_Menu_.html @@ -19,11 +19,11 @@

Description

-All widgets that have a menu in FLTK are subclassed off of this class. +All widgets that have a menu in FLTK are subclassed off of this class. Currently FLTK provides you with Fl_Menu_Button, Fl_Menu_Bar, and Fl_Choice -. +.

The class contains a pointer to an array of structures of type Fl_Menu_Item. The @@ -71,7 +71,7 @@ be "private": a dynamically allocated array managed by the Fl_Menu_. -

Fl_Menu_::Fl_Menu_(int x, int y, int w, +

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

Creates a new Fl_Menu_ widget using the given position, size, @@ -124,9 +124,9 @@ will result in a submenu called "foo" and one in that called copied to new memory and can be freed. The other arguments (including the shortcut) are copied into the menu item unchanged.

-

If an item exists already with that name then it is replaced with -this new one. Otherwise this new one is added to the end of the -correct menu or submenu. The return value is the offset into the array +

If an item exists already with that name then it is replaced with +this new one. Otherwise this new one is added to the end of the +correct menu or submenu. The return value is the offset into the array that the new entry was placed at.

The return value is the index into the array that the entry was put.

@@ -163,42 +163,42 @@ href=Fl_Menu_Item.html>Fl_Menu_Item.
int Fl_Menu_::value(int)
const Fl_Menu_Item* mvalue() const
int Fl_Menu_::value(const Fl_Menu_Item*)

- The value is the index into menu() 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. + The value is the index into menu() 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. -

const Fl_Menu_Item* +

const Fl_Menu_Item* Fl_Menu_::test_shortcut()

- Only call this in response to FL_SHORTCUT events. If the -event matches an entry in the menu that entry is selected and the -callback will be done (or changed() will be set). This allows -shortcuts directed at one window to call menus in another. + Only call this in response to FL_SHORTCUT events. If the +event matches an entry in the menu that entry is selected and the +callback will be done (or changed() will be set). This allows +shortcuts directed at one window to call menus in another.

void Fl_Menu_::global()

- Make the shortcuts for this menu work no matter what window has the + Make the shortcuts for this menu work no matter what window has the focus when you type it. This is done by using -Fl::add_handler(). This Fl_Menu_ widget does not -have to be visible (ie the window it is in can be hidden, or it does -not have to be put in a window at all). -

Currently there can be only one global()menu. Setting a new +Fl::add_handler(). This Fl_Menu_ widget does not +have to be visible (ie the window it is in can be hidden, or it does +not have to be put in a window at all). +

Currently there can be only one global()menu. Setting a new one will replace the old one. There is no way to remove the global() setting (so don't destroy the widget!)

const char* Fl_Menu_::text() const
const char* Fl_Menu_::text(int i) const

- Returns the title of the last item chosen, or of item i. + Returns the title of the last item chosen, or of item i.

Fl_Color Fl_Menu_::textcolor() const
void Fl_Menu_::textcolor(Fl_Color)

- Get or set the current color of menu item labels. + Get or set the current color of menu item labels.

Fl_Font Fl_Menu_::textfont() const
void Fl_Menu_::textfont(Fl_Font)

- Get or set the current font of menu item labels. + Get or set the current font of menu item labels.

uchar Fl_Menu_::textsize() const
void Fl_Menu_::textsize(uchar)

- Get or set the font size of menu item labels. + Get or set the font size of menu item labels.

Fl_Boxtype Fl_Menu_::down_box() const
void Fl_Menu_::down_box(Fl_Boxtype)

- This box type is used to surround the currently-selected items in the + This box type is used to surround the currently-selected items in the menus. If this is FL_NO_BOX then it acts like FL_THIN_UP_BOX and selection_color() acts like FL_WHITE, for back compatability. -- cgit v1.2.3