widget_class (library)

Author(s): Montserrat Urraca.

Version: 1.11#222 (2004/5/24, 13:8:7 CEST)

Version of last change: 1.9#150 (2003/12/4, 17:35:4 CET)

• Usage and interface (widget_class)
• Documentation on exports (widget_class)

Usage and interface (widget_class)

Documentation on exports (widget_class)

PREDICATE: text_characters/1:

Usage 1: text_characters(Text)

• Description: Indicates the Text to be displayed in the widget.
• Call and exit should be compatible with: Text is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Text is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: text_characters(Text)

• Description: Text which is displayed in the widget.
• Call and exit should be compatible with: Text is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Text is a free variable. (term_typing:var/1)

PREDICATE: font_type/1:

Usage 1: font_type(Font)

• Description: Indicates the Font of the widget's text.
• Call and exit should be compatible with: Font is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Font is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: font_type(Font)

• Description: Gets the Font of the widget's text.
• Call and exit should be compatible with: Font is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Font is a free variable. (term_typing:var/1)

PREDICATE: background_color/1:

Usage 1: background_color(Background)

• Description: Indicates the Background color. Default to gray.
• Call and exit should be compatible with: Background is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Background is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: background_color(Background)

• Description: Returns the Background color.
• Call and exit should be compatible with: Background is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Background is a free variable. (term_typing:var/1)

PREDICATE: borderwidth_value/1:

Usage 1: borderwidth_value(BorderWidth)

• Description: Indicates the width's border. Default to 2.
• Call and exit should be compatible with: BorderWidth is a number. (basic_props:num/1)
• The following properties should hold at call time: BorderWidth is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: borderwidth_value(BorderWidth)

• Description: Gets the width's border.
• Call and exit should be compatible with: BorderWidth is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: BorderWidth is a free variable. (term_typing:var/1)

PREDICATE: foreground_color/1:

Usage 1: foreground_color(Foreground)

• Description: Indicates the Foreground color. Default to black
• Call and exit should be compatible with: Foreground is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Foreground is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: foreground_color(Foreground)

• Description: Gets the Foreground color.
• Call and exit should be compatible with: Foreground is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Foreground is a free variable. (term_typing:var/1)

PREDICATE: highlightbackground_color/1:

Usage 1: highlightbackground_color(Color)

• Description: Color specifies the highlight background color. Default to white
• Call and exit should be compatible with: Color is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Color is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: highlightbackground_color(Color)

• Description: Gets the Color of the highlight background.
• Call and exit should be compatible with: Color is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Color is a free variable. (term_typing:var/1)

PREDICATE: highlight_color/1:

Usage 1: highlight_color(Color)

• Description: Color specifies the highlight color. Default to white
• Call and exit should be compatible with: Color is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Color is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: highlight_color(Color)

• Description: Gets the Color of the highlight.
• Call and exit should be compatible with: Color is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Color is a free variable. (term_typing:var/1)

PREDICATE: width_value/1:

Usage 1: width_value(Width)

• Description: Specifies the Width for the widget. Default to 0
• Call and exit should be compatible with: Width is an integer. (basic_props:int/1)
• The following properties should hold at call time: Width is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: width_value(Width)

• Description: Gets the Width specified for the widget.
• Call and exit should be compatible with: Width is an integer. (basic_props:int/1)
• The following properties should hold at call time: Width is currently a term which is not a free variable. (term_typing:nonvar/1)

PREDICATE: relief_type/1:

Usage 1: relief_type(Relief)

• Description: Specifies a desired Relief for the widget. Default to sunken
• Call and exit should be compatible with: Relief is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Relief is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: relief_type(Relief)

• Description: Gets the Relief of the widget.
• Call and exit should be compatible with: Relief is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Relief is a free variable. (term_typing:var/1)

PREDICATE: side_type/1:

Usage 1: side_type(Side)

• Description: Specifies which Side of the master, the slave(s) will be packed against. Must be left, right, top or bottom. Defaults to top
• Call and exit should be compatible with: Side is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Side is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: side_type(Side)

• Description: Gets the position of the canvas.
• Call and exit should be compatible with: Side is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Side is a free variable. (term_typing:var/1)

PREDICATE: expand_value/1:

Usage 1: expand_value(Value)

• Description: Specifies whether the slaves should be expanded to consume extra space in their master. Value may have any proper boolean value, such as 1 or 0. Defaults to 0
• Call and exit should be compatible with: Value is an integer. (basic_props:int/1)
• The following properties should hold at call time: Value is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: expand_value(Value)

• Description: Gets the boolean value which indicates if the slaves should be expanded or no.
• Call and exit should be compatible with: Value is an integer. (basic_props:int/1)
• The following properties should hold at call time: Value is a free variable. (term_typing:var/1)

PREDICATE: fill_type/1:

Usage 1: fill_type(Option)

• Description: If a slave's parcel is larger than its requested dimensions, this option may be used to stretch the slave. Option must have one of the following values: none ( this is the default), x, y, both
• Call and exit should be compatible with: Option is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Option is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: fill_type(Option)

• Description: Gets the fill value of the canvas
• Call and exit should be compatible with: Option is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Option is a free variable. (term_typing:var/1)

PREDICATE: padx_value/1:

Usage 1: padx_value(Amount)

• Description: Amount specifies how much horizontal external padding to leave on each side of the slave(s). Amount defaults to 0
• Call and exit should be compatible with: Amount is an integer. (basic_props:int/1)
• The following properties should hold at call time: Amount is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: padx_value(Amount)

• Description: Gets the Amount which specifies how much horizontal external padding to leave on each side of the slaves.
• Call and exit should be compatible with: Amount is an integer. (basic_props:int/1)
• The following properties should hold at call time: Amount is a free variable. (term_typing:var/1)

PREDICATE: pady_value/1:

Usage 1: pady_value(Amount)

• Description: Amount specifies how much vertical external padding to leave on each side of the slave(s). Amount defaults to 0
• Call and exit should be compatible with: Amount is an integer. (basic_props:int/1)
• The following properties should hold at call time: Amount is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: pady_value(Amount)

• Description: Gets the Amount which specifies how much vertical external padding to leave on each side of the slaves.
• Call and exit should be compatible with: Amount is an integer. (basic_props:int/1)
• The following properties should hold at call time: Amount is a free variable. (term_typing:var/1)

PREDICATE: row_value/1:

Usage 1: row_value(Row)

• Description: Indicates the Row in which the widget should be allocated.
• Call and exit should be compatible with: Row is an integer. (basic_props:int/1)
• The following properties should hold at call time: Row is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: row_value(Row)

• Description: Gets the Row in which the widget is allocated.
• Call and exit should be compatible with: Row is an integer. (basic_props:int/1)
• The following properties should hold at call time: Row is a free variable. (term_typing:var/1)

PREDICATE: rowspan_value/1:

Usage 1: rowspan_value(Row)

• Description: Indicates the number of Row which are going to be occupied in the grid.
• Call and exit should be compatible with: Row is an integer. (basic_props:int/1)
• The following properties should hold at call time: Row is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: rowspan_value(Row)

• Description: Gets the number of Row which are occupied by the widget in the grid.
• Call and exit should be compatible with: Row is an integer. (basic_props:int/1)
• The following properties should hold at call time: Row is a free variable. (term_typing:var/1)

PREDICATE: column_value/1:

Usage 1: column_value(Column)

• Description: Indicates the Column in which the widget should be allocated.
• Call and exit should be compatible with: Column is an integer. (basic_props:int/1)
• The following properties should hold at call time: Column is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: column_value(Column)

• Description: Gets the Column in which the widget is allocated.
• Call and exit should be compatible with: Column is an integer. (basic_props:int/1)
• The following properties should hold at call time: Column is a free variable. (term_typing:var/1)

PREDICATE: columnspan_value/1:

Usage 1: columnspan_value(Column)

• Description: Indicates the number of Column which are going to be occupied in the grid.
• Call and exit should be compatible with: Column is an integer. (basic_props:int/1)
• The following properties should hold at call time: Column is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: columnspan_value(Column)

• Description: Gets the number of Column which are occupied by the widget in the grid.
• Call and exit should be compatible with: Column is an integer. (basic_props:int/1)
• The following properties should hold at call time: Column is a free variable. (term_typing:var/1)

PREDICATE: event_type_widget/1:

Usage 1: event_type_widget(EventType)

• Description: The event EventType is going to be manage by the interface.
• Call and exit should be compatible with: EventType is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: EventType is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: event_type_widget(EventType)

• Description: Gets the event EventType which is going to be manage by the interface.
• Call and exit should be compatible with: EventType is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: EventType is a free variable. (term_typing:var/1)

PREDICATE: action_widget/3:

Usage 1: action_widget(Input, Output, Term)

• Description: Executes Term with Input value and Output variable.
• Call and exit should be compatible with: Input is currently instantiated to an atom. (term_typing:atom/1) Output is currently instantiated to an atom. (term_typing:atom/1) Term is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Input is currently a term which is not a free variable. (term_typing:nonvar/1) Output is currently a term which is not a free variable. (term_typing:nonvar/1) Term is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: action_widget(Input, Output, Term)

• Description: Term is associated to the action of the object indicated with the operacion event_type_widget.
• Call and exit should be compatible with: Input is currently instantiated to an atom. (term_typing:atom/1) Output is currently instantiated to an atom. (term_typing:atom/1) Term is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Input is currently a term which is not a free variable. (term_typing:nonvar/1) Output is currently a term which is not a free variable. (term_typing:nonvar/1) Term is a free variable. (term_typing:var/1)

PREDICATE: action_widget/1:

Usage 1: action_widget(Term)

• Description: Term is going to be associated to the action of the object indicated with the operacion event_type_widget.
• Call and exit should be compatible with: Term is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Term is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: action_widget(Term)

• Description: Term is associated to the action of the object indicated with the operacion event_type_widget.
• Call and exit should be compatible with: Term is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Term is a free variable. (term_typing:var/1)

PREDICATE: creation_options/1:

Usage: creation_options(OptionsList)

• Description: Creates a list with the options supported by the widget.
• Call and exit should be compatible with: OptionsList is a list. (basic_props:list/1)
• The following properties should hold at call time: OptionsList is a free variable. (term_typing:var/1)

PREDICATE: creation_position/1:

Usage: creation_position(OptionsList)

• Description: Creates a list with the options supported by the pack command.
• Call and exit should be compatible with: OptionsList is a list. (basic_props:list/1)
• The following properties should hold at call time: OptionsList is a free variable. (term_typing:var/1)

PREDICATE: creation_position_grid/1:

Usage: creation_position_grid(OptionsList)

• Description: Creates a list with the options supported by the grid command.
• Call and exit should be compatible with: OptionsList is a list. (basic_props:list/1)
• The following properties should hold at call time: OptionsList is a free variable. (term_typing:var/1)

PREDICATE: creation_bind/1:

Usage: creation_bind(BindList)

• Description: Creates a list with the event to be manage and the action associated to this event.
• Call and exit should be compatible with: BindList is a list. (basic_props:list/1)
• The following properties should hold at call time: BindList is a free variable. (term_typing:var/1)

Go to the first, previous, next, last section, table of contents.