From 9e3f8a1db6028935ea640c00e15674e1a7456530 Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Sun, 29 Oct 2006 14:16:03 +0000 Subject: Documentation fixes. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5533 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/Fl_Menu_.html | 197 +++++++++++++++++++++++++------------------- 1 file changed, 114 insertions(+), 83 deletions(-) (limited to 'documentation/Fl_Menu_.html') diff --git a/documentation/Fl_Menu_.html b/documentation/Fl_Menu_.html index d60228389..fb72bff7c 100644 --- a/documentation/Fl_Menu_.html +++ b/documentation/Fl_Menu_.html @@ -1,4 +1,8 @@ - + + + Fl_Menu_ + +

class Fl_Menu_

@@ -80,47 +84,11 @@ int h, const char *label = 0) Creates a new Fl_Menu_ widget using the given position, size, and label string. menu() is initialized to null. +

virtual Fl_Menu_::~Fl_Menu_()

If the menu array is private the memory it uses is freed. -

const Fl_Menu_Item* Fl_Menu_::menu() -const

- -Returns a pointer to the array of Fl_Menu_Items. This will either be -the value passed to menu(value) or the private copy. - -

void Fl_Menu_::menu(const Fl_Menu_Item*)

-Set the menu array pointer directly. If the old menu is private it is -deleted. NULL is allowed and acts the same as a zero-length -menu. If you try to modify the array (with add(), replace(), or -delete()) a private copy is automatically done. - -

const Fl_Menu_Item* Fl_Menu_::mvalue() -const

- -

Returns a pointer to the last menu item that was picked. - -

void Fl_Menu_::copy(const -Fl_Menu_Item*, void* user_data = 0)

- -

The menu is set to a private copy of the passed Fl_Menu_Item -array. This is useful if you want to modify the flags of the -menu items. If the user_data argument is non-NULL, then -the user_data members of the menu items are set to the -given value. - -

void Fl_Menu_::clear()

-Same as menu(NULL), set the array pointer to null, indicating -a zero-length menu. - -

int Fl_Menu_::size() const

- -This returns the number of Fl_Menu_Item structures that make up the -menu, correctly counting submenus. This includes the "terminator" -item at the end. To copy a menu array you need to copy -size()*sizeof(Fl_Menu_Item) bytes. If the menu is -NULL this returns zero (an empty menu will return 1).

int Fl_Menu_::add(const char* label, const char* shortcut, Fl_Callback*, void *user_data=0, int flags=0)
@@ -138,7 +106,7 @@ special characters in the label string. The "&" character specifies that the following character is an accelerator and will be underlined. The "\" character is used to escape the next character in the string. Labels starting with the "_" character -cause a divider to be placed before that menu item.

+cause a divider to be placed after that menu item.

A label of the form "foo/bar/baz" will create a submenus called "foo" and "bar" with an @@ -185,51 +153,29 @@ with Forms and other GL programs. The section strings use the same special characters as described for the long version of add()

-

void Fl_Menu_::replace(int n, const char *) -

-Changes the text of item n. This is the only way to get -slash into an add()'ed menu item. If the menu array was directly set -with menu(x) then copy() is done to make a private array. - -

void Fl_Menu_::remove(int n)

- -Deletes item n from the menu. If the menu array was directly -set with menu(x) then copy() is done to make a private array. +

void Fl_Menu_::clear()

+Same as menu(NULL), set the array pointer to null, indicating +a zero-length menu. -

void Fl_Menu_::shortcut(int i, int n);

-Changes the shortcut of item i to n. +

void Fl_Menu_::copy(const +Fl_Menu_Item*, void* user_data = 0)

-

void Fl_Menu_::mode(int i, int x);

+

The menu is set to a private copy of the passed Fl_Menu_Item +array. This is useful if you want to modify the flags of the +menu items. If the user_data argument is non-NULL, then +the user_data members of the menu items are set to the +given value. -Changes the flags of item i. For a list of the flags, see Fl_Menu_Item. -

int Fl_Menu_::value() const -
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. +

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 +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. -

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. -

void Fl_Menu_::global()

- 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 -one will replace the old one. There is no way to remove the -global() setting (so don't destroy the widget!)

const Fl_Menu_Item *Fl_Menu_::find_item(const char *name);

@@ -238,6 +184,7 @@ pathname. If no matching menu item can be found, a NULL pointer is returned. This function does not search submenus that are linked via FL_SUBMENU_POINTER.

+

int Fl_Menu_::item_pathname(char *name, int namelen ) const;
int Fl_Menu_::item_pathname(char *name, int namelen, const Fl_Menu_Item *finditem) const;

@@ -256,22 +203,106 @@ int Fl_Menu_::item_pathname(char *name, int namelen,

In the case of errors (-1 or -2), 'name' will be an empty string. + +

const Fl_Menu_Item* Fl_Menu_::menu() +const

+ +Returns a pointer to the array of Fl_Menu_Items. This will either be +the value passed to menu(value) or the private copy. + +

void Fl_Menu_::menu(const Fl_Menu_Item*)

+Set the menu array pointer directly. If the old menu is private it is +deleted. NULL is allowed and acts the same as a zero-length +menu. If you try to modify the array (with add(), replace(), or +delete()) a private copy is automatically done. + + +

void Fl_Menu_::mode(int i, int x);

+ +Changes the flags of item i. For a list of the flags, see Fl_Menu_Item. + + +

const Fl_Menu_Item* Fl_Menu_::mvalue() +const

+ +

Returns a pointer to the last menu item that was picked. + + +

void Fl_Menu_::remove(int n)

+ +Deletes item n from the menu. If the menu array was directly +set with menu(x) then copy() is done to make a private array. + + +

void Fl_Menu_::replace(int n, const char *) +

+ +Changes the text of item n. This is the only way to get +slash into an add()'ed menu item. If the menu array was directly set +with menu(x) then copy() is done to make a private array. + + +

void Fl_Menu_::shortcut(int i, int n);

+ +Changes the shortcut of item i to n. + + +

int Fl_Menu_::size() const

+ +This returns the number of Fl_Menu_Item structures that make up the +menu, correctly counting submenus. This includes the "terminator" +item at the end. To copy a menu array you need to copy +size()*sizeof(Fl_Menu_Item) bytes. If the menu is +NULL this returns zero (an empty menu will return 1). + + +

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. +

void Fl_Menu_::global()

+ 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 +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. +

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

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. + +

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

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 -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. + + +

int Fl_Menu_::value() const +
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. + + + + -- cgit v1.2.3