menu_class (library)

Author(s): Montserrat Urraca.

Version: 1.10#7 (2006/4/26, 19:22:13 CEST)

Version of last change: 1.9#133 (2003/12/4, 17:33:46 CET)

Usage and interface (`menu_class`)

Library usage: :- use_module(library(menu_class)).
Exports:
- Predicates: name_menu/1, menu_data/1, label_value/1, tearoff_value/1, tcl_name/1, creation_options/1, creation_options_entry/1, creation_menu_name/1.
Other modules used:
- System library modules: objects/objects_rt, tcltk_obj/window_class, tcltk_obj/menu_entry_class, tcltk/tcltk, tcltk/tcltk_low_level, lists.

PREDICATE: name_menu/1:

Usage: name_menu(+Name)

Description: Indicates the Name of the menubutton associated.
Call and exit should be compatible with: +Name is currently instantiated to an atom. (term_typing:atom/1)

PREDICATE: menu_data/1:

Usage 1: menu_data(+Menu)

Description: Menu posted when cascade entry is invoked.
Call and exit should be compatible with: +Menu is currently instantiated to an atom. (term_typing:atom/1)

Usage 2: menu_data(-Menu)

Description: Gets the Menu asociated to the cascade entry.
Call and exit should be compatible with: -Menu is currently instantiated to an atom. (term_typing:atom/1)

PREDICATE: label_value/1:

Usage 1: label_value(+Value)

Description: Value specifies a string to be displayed as an identifying label in the menu entry.
Call and exit should be compatible with: +Value is currently instantiated to an atom. (term_typing:atom/1)

Usage 2: label_value(-Value)

Description: Gets the string which identify the menu entry.
Call and exit should be compatible with: -Value is currently instantiated to an atom. (term_typing:atom/1)

PREDICATE: tearoff_value/1:

Usage 1: tearoff_value(+Tearoff)

Description: Tearoff must have a proper boolean value, which specifies wheter or not the menu should include a tear-off entry at the top. Defaults to 1.
Call and exit should be compatible with: +Tearoff is currently instantiated to an atom. (term_typing:atom/1)

Usage 2: tearoff_value(-Tearoff)

Description: Gets the Tearoff value
Call and exit should be compatible with: -Tearoff is currently instantiated to an atom. (term_typing:atom/1)

PREDICATE: tcl_name/1:

Usage: tcl_name(-Widget)

Description: Specifies the name of the Widget. In this case is menu.
Call and exit should be compatible with: -Widget is currently instantiated to an atom. (term_typing:atom/1)

PREDICATE: creation_options/1:

Usage: creation_options(-OptionsList)

Description: Creates a list with the options supported by the menu.
Call and exit should be compatible with: -OptionsList is a list. (basic_props:list/1)

PREDICATE: creation_options_entry/1:

Usage: creation_options_entry(-OptionsList)

Description: Creates a list with the options of the menu entry.
Call and exit should be compatible with: -OptionsList is a list. (basic_props:list/1)

PREDICATE: creation_menu_name/1:

Usage: creation_menu_name(-OptionsList)

Description: Creates a list with the name of the menu.
Call and exit should be compatible with: -OptionsList is a list. (basic_props:list/1)