Rtl_scrollwin

Rtl_scrollwin
Prev	Appendix A. Reference	Next

Name

rtl_scrollwin — Create and manipulate rtl_scrollwin windows

Synopsis

          package require rtl_scrollwin

          rtl_scrollwin pathName ?options ?

Runtime Library Options

-creator

The RTL based option creator is used to instantiate the template rtl_scrollwin 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

-xscrollcommand, -yscrollcommand, -background, -borderwidth, -relief, -highlightbackground, -highlightcolor, -highlightthickness, -width, -height: See the options manual entry for details on the standard options.

Window-specific Options

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

Accepts a window pathName. This window will be contained.

The assigned window should be a child to the container window.

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

Modifies the contained window expanding behavior. the window may expand / shrink in x or y direction

Note no scrollbar is needed in this direction!

Example A.1. Rtl_scrollwin -fill

rtl_scrollwin .scrollwin \
     -widget .scrollwin.child \
       -fill x
 
# Create a child window:
frame .scrollwin.child -width 248 \
    -height 2048

»adapt« is auto called by »-fill«

Description

The »rtl_scrollwin« command creates a »rtl_scrollwin« window.

»rtl_scrollwin« is used for dialogs, larger than their space on the display. »rtl_scrollwin« accepts such dialogs through the »-widget« property.

2008/ added minor changes to let scrollwin accept ttk::frames from Tk 8.5, not enough to warrant a new version, though.

Window Command

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

          pathName option ?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:

pathName cget option

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

pathName configure ?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_scrollwin command.

pathName unsetVar item