Copyright © 2009 Arndt Roger Schneider

Rtl_gridwin
Prev Chapter 2. Basic Templates Next

Name

rtl_gridwin — Create and manipulate rtl_gridwin windows

Synopsis

          ;; package require rtl_gridwin in Tcl/Tk.
          (with-ltk-rtl_gridwin
             (make-instance 'rtl_gridwin ?options ?))

Runtime Library Options

-creator

The RTL based option creator is used to instantiate the template rtl_gridwin with a Tk Window. The used creator window must have a -class property.

Acceptable Tk Windows are: toplevel for floating windows, and frame for embedded windows.

Standard Options

-width, -height, -background, -highlightbackground, -highlightcolor, -highlightthickness, -relief, -borderwidth, -activebackground, -repeatdelay, -repeatinterval, -troughcolor

See the options manual entry for details on the standard options.

Window-specific Options

Command-Line Name: -window, Database Name: window, Database Class; -

A valid Tk Window. This »window« can be a a plain or composite window, too.

Command-Line Name: -auto, Database Name: auto, Database Class; -

Set auto scrollbar insertion for this window.

Possible values are: »x«, »y«, »yes«, »1«, »no«, »0« and »none«.

The attached Scrollbars are auto-inserted, according to the value of »-auto«.

Command-Line Name: -fill, Database Name: fill, Database Class; -

Set scrollbar fill insertion mode.

Possible values are »x«, »y«, »both« and »none«.

Command-Line Name: -sides, Database Name: sides, Database Class; -

Set where the scrollbars are inserted.

Possible values are: »top«, »bottom«, »left«, »right« and combinations thereof.

Command-Line Name: -scrollborderwidth, Database Name: scrollBorderWidth, Database Class; -

border width of the contained scrollbars. See also »-scrollrelief«.

Command-Line Name: -elementborderwidth, Database Name: elementBorderWidth, Database Class; BorderWidth

Specifies the width of borders drawn around the internal elements of the scrollbar (the two arrows and the slider). The value may have any of the forms acceptable to Tk_GetPixels . If this value is less then zero, the value of the borderWidth option is used in its place.

Command-Line Name: -scrollhighlightthickness, Database Name: scrollhighlightthickness, Database Class: -

Undocumented

Command-Line Name: -scrollrelief, Database Name: scrollRelief, Database Class; -

The contained scrollbar’s inactive relief.

Command-Line Name: -scrollwidth, Database Name: scrollWidth, Database Class; -

The scrollbar’s width dimension.

Command-Line Name: -pad, Database Name: pad, Database Class; -

Extra white space between the internal windows; both client and scrollbars and the outer border.

Under AQUA® pad is 0; under other platforms 2p.

Command-Line Name: -autohide, Database Name: autoHide, Database Class; -

Controls the response to <enter> and <leave> events. If »-autohide« is set the attached scrollbars vanish, when the cursor leaves the client window.

Boolean value »0« or »1«.

Description

The »rtl_gridwin« command create a »rtl_gridwin« window.

»rtl_gridwin« is a container window, combing a scroll able window with scrollbars.

The scroll able window is made known to the »rtl_gridwin« window via its »-widget« property. The supplied window should be a child of the »rtl_gridwin« window. The window inside of »rtl_gridwin« are managed through the »grid« geometry manager.

Extended scrollbar management in combination with rslider. rslider handles 'flashing' the visible scrollbars whenever a content change takes place. This will be omitted if a 'hidden' entry is found for the affected scrollbar. 'hidden' is set and cleared by "gridwin's" private functions 'leave' & 'enter' -- leave sets 'hidden' to true while 'enter' clears 'hidden'.

Window Command

A Window created through the rtl_gridwin command exposes various functions. Using these functions has the following general form: 

(option object ?arg arg ...?)

PathName is the same as the window path name. Option and the args determine the exact behavior of the command. The following commands are possible for this window:

(cget object :option)

Returns the current value of the configuration option given by option. Option may have any of the values accepted by the rtl_gridwin command.

(configure object ?:option? ?value option value ...?)

Query or modify the configuration options of the window. If no option is specified, returns a list describing all of the available options for pathName (see Tk_ConfigureInfo for information on the format of this list). If option is specified with no value, then the command returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no option is specified). If one or more option-value pairs are specified, then the command modifies the given window option(s) to have the given value(s); in this case the command returns an empty string. Option may have any of the values accepted by the rtl_gridwin command.

(remove object )

Remove scroll actions from current widget and also unmap that widget.

(update object ... )

Refresh and remanage current widget

Dependencies

  • rtl

Prev Up Next
Rtl_scrollwin Home Chapter 3. Listbox and Tree Templates
SourceForge Logo Gestalt Items