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

canvas_class (library)

Author(s): Montserrat Urraca.

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

Version of last change: 1.9#123 (2003/12/4, 17:32:57 CET)

Usage and interface (`canvas_class`)

Library usage: :- use_module(library(canvas_class)).
Exports:
- Predicates: canvas_class/0, canvas_class/1, destructor/0, show/0, hide_/0, show_shape/1, hide_shape/1, width_value/1, height_value/1, side_type/1, expand_value/1, fill_type/1, padx_value/1, pady_value/1.
- Regular Types: shape/1, option/1.
- Multifiles: $class$/1, class$super/2, class$initial_state/3, class$virtual/6, class$attr_template/4, class$default_cons/1, class$constructor/4, class$destructor/3, class$implements/2.
Other modules used:
- System library modules: class/class_rt, class/virtual, objects/objects_rt, tcltk_obj/window_class, tcltk_obj/shape_class, system, strings, lists, tcltk/tcltk, tcltk/tcltk_low_level.

Documentation on exports (`canvas_class`)

REGTYPE: shape/1:

Each item type is characterized in two ways: first, the form of the create command used to create instances of the type; and second, a set of configuration options for items of that type, which may be used in the create and itemconfigure widget commands.

Usage: shape(S)

Description: S is a reference to one type of the items supported by canvas widgets.

REGTYPE: option/1:

Usage: option(O)

Description: O is hidden if the Shape is not visible or shown if its visible.

PREDICATE: canvas_class/0:

Usage:

Description: Creates a new interpreter, asserting the predicate interp(I) and the canvas object.

PREDICATE: canvas_class/1:

Usage: canvas_class(ItemsList)

Description: Adds items of the list to the canvas object.
Call and exit should be compatible with: ItemsList is a list. (basic_props:list/1)
The following properties should hold at call time: ItemsList is currently a term which is not a free variable. (term_typing:nonvar/1)

PREDICATE: destructor/0:

Usage:

Description: Deletes the shapes of the canvas object and the object.

PREDICATE: show/0:

Usage:

Description: Adds shapes to the canvas object.

PREDICATE: hide_/0:

Usage:

Description: Hides shapes from the canvas object.

PREDICATE: show_shape/1:

Usage: show_shape(Shape)

Description: Shows Shape into the canvas object.
Call and exit should be compatible with: Shape is a reference to one type of the items supported by canvas widgets. (canvas_class_doc:shape/1)
The following properties should hold at call time: Shape is currently a term which is not a free variable. (term_typing:nonvar/1)

PREDICATE: hide_shape/1:

Usage: hide_shape(Shape)

Description: Hides Shape from the canvas object.
Call and exit should be compatible with: Shape is a reference to one type of the items supported by canvas widgets. (canvas_class_doc:shape/1)
The following properties should hold at call time: Shape is currently a term which is not a free variable. (term_typing:nonvar/1)

PREDICATE: width_value/1:

Usage 1: width_value(Width)

Description: Sets the Width of the canvas. Default 100.
Call and exit should be compatible with: Width is a number. (basic_props:num/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 of the canvas.
Call and exit should be compatible with: Width is a number. (basic_props:num/1)
The following properties should hold at call time: Width is a free variable. (term_typing:var/1)

PREDICATE: height_value/1:

Usage 1: height_value(Height)

Description: Sets the Height of the canvas. Default 50.
Call and exit should be compatible with: Height is a number. (basic_props:num/1)
The following properties should hold at call time: Height is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: height_value(Height)

Description: Gets the Height of the canvas.
Call and exit should be compatible with: Height is a number. (basic_props:num/1)
The following properties should hold at call time: Height 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 Side 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 no. Defaults to 0
Call and exit should be compatible with: Value is currently instantiated to an atom. (term_typing:atom/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 currently instantiated to an atom. (term_typing:atom/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. Style 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 currently instantiated to an atom. (term_typing:atom/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 currently instantiated to an atom. (term_typing:atom/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 currently instantiated to an atom. (term_typing:atom/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 currently instantiated to an atom. (term_typing:atom/1)
The following properties should hold at call time: Amount is a free variable. (term_typing:var/1)