Copyright © 2008, 2009 Arndt Roger Schneider

Rtl_tabset
Prev Appendix A. Reference Next

Name

rtl_tabset — Create and manipulate rtl_tabset windows

Synopsis

          package require rtl_tabset
        
          rtl_tabset pathName ?options ?

Runtime Library Options

-creator

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

-orient, -width, -height, -background, -borderwidth, -relief, -highlightthickness, -highlightbackground, -highlightcolor, -troughColor, -takeFocus, -foreground

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

Window-specific Options

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

List, what tabs are displayed inside the Rtl_tabset

Example A.4. Rtl_tabset -show

# Create the tabset:
rtl_tabset .tabset ...

# Add tabs to the tabset:
.tabset add alpha ...
.tabset add beta ...
.tabset add gamma ...
.tabset add delta ..

# Hide the tab: beta, 
# rearrange delta and gamma:
.tabset configure -show {alpha delta gamma }

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

The default shape and behavior for each tab. The tab type can be predefined / changed for all tabs.

Default value is rtl_tabItem. The tab type bundled with the tabset.

For altering the shape of tabs see also: »setformat«.

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

Dimension, defines how much two tabs overlap each other. Default value is »-5« (Tabs do overlap by 5 pixel).

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

Dimension, defines the minimal distance between then selected tab and the border of the tabset. This property is only used, when »-autovisible« is set. The first and last tabs are limited to »-borderspace«.

Default value is 50p (50 points).

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

Dimension, defines the distance from the first and last tab to the tabset border.

Default value is: 10 (10 pixel).

See also »-taboffset«.

Command-Line Name: -autovisible, Database Name: autoVisible, Database Class; -

Boolean value.

The selected tab is automatically moved in the visible region, when »-autovisible« is set to 1.

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

Boolean value. All tabs are centered in the visible region.

»-centered« is set under AQUA®.

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

Dimension, defines the distance of the limiting line to the tabs. The limiting line is rendered below the tabs, in an horizontal oriented tabset. Default value is -1 (-1 pixel), the tabs overlap with the limiting line by 1 pixel.

Description

Figure A.1. rtl_tabset


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

»rtl_tabset« is a canvas based composite tabset / notebook window. It is highly customizable. Either the individual tab design and the default design can be changed.

The standard design lets fade inactive tabs into the background of the tabset window. The tab background gets semi-transparent.

Each tab, features its own foreground and background colors. This colors are used when the tab is selected (front most). The tabset’s foreground color is used for any tab faded into the background.

Tabs (default is »rtl_tabItem«), are customizable, too.

TkPath is used, when available.

Focus Management

Pre-implemented for TkPath elements. use alternate tabItems with a »focusframe« tag on a TkPath object to see it. The focus highlighting requires TkPath and will not work for Tk canvas based tabs! The property »-strokeopacity« is set to 1.0 when the tabset has the focus and 0.0 when lost.

The tab itself is prepared for using focus rings, A call to the dummy funcition focusframes is included; overwrite focusframes to gain highlighting.

The Example A.5, “focusframe inside »gtabset«” shows the implementation from »gtabset«, it contains a reference to »gstripes::focuspathes«. The functionality isn’t part of the »rtl«, and hence not implemented inside the »rtl_tabset«.

Example A.5. focusframe inside »gtabset«

proc rtl_tabset::private::focusframes {
    c coords bbox tags {fmCoords {M %s }}
} {
  set base [winfo parent $c]
  return \
    [::gstripes::focuspathes \
       $c $coords $bbox \
       [$base cget -highlightthickness] \
       [$base cget -highlightcolor] \
       [opget $base highlightFraction 90] \
       $tags $fmCoords]
}

Window Command

A Window created through the rtl_tabset 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_tabset 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_tabset command.

pathName deactivate ?color? ?opacity?

Ported from gstripes::deactivate. See also activate. 1:1 copied from gstripes.tcl! Written : 09/15/2008, Roger

pathName delete item ...

Removes the tab »item« from the tabset.

pathName entryconfigure item ...

Allow a menu item equally behavior.

pathName setformat value

Setformat is intended to reformat the current tab outline. If no format is specified the horizontal or vertical definition from the private namespace will be used. Setformat is similar to other attributes but due it's extend not definable on the command line. NOTE: the given format must corrospond with the orientation of the tabset widget.

pathName see item

Bring the given item into the visible section. If the given item is already visible no action will be performed.

pathName previous

Undocumented.

pathName responsMap

Internal used.

Called in from with an event handler for the <Map> event. Initial Version: roger 03/23/2007

pathName activate

Make this dialog fully accessible again. 1:1 copied from gstripes.tcl Written : 09/14/2008, Roger

pathName add item ...

Extends the tabset »path« with a new tab named »item«.

pathName yview ...

Send yview actions to the canvas widget

pathName centerOnX

Center the tabs in tabset. See also »-centered«, needed for AQUA. Initial Version: roger 03/22/2007

pathName focusIn

Undocumented.

pathName next

Undocumented.

pathName curselection

Get current selected item

pathName size

Gives the current size of associated items.

pathName focusOut

Undocumented.

pathName setselection item ?flag?

Activate the given item. Flag is used to invoke the item. Since setselection is also used by other methods, flag will ensure not to notify the item about this internal stuff.

pathName type ...

Query what kind of tabs are created. Related to »setformat«. This »type« is the same for all created tabs–except for tabs with an explicit defined type.

pathName init

Secondary constructor for template rtl_tabset.

Creates focus keyboard handling. Please note, the »-takefocus« property from the canvas window must be set to 1 for proper focus management. The focus management depends on what sort of an item is used and has to be reimplemented for Tk canvas-only tabsets. Revision : 05/20/2009, Roger

pathName entrycget item attr

See above ...

pathName responsConfig

Initial Version: roger 03/22/2007

pathName tabnames

Retrieve all tabs, known to the tabset. The tabset may contain hidden tabs (see the »-show« property), tabnames includes hidden tabs.

pathName xview ...

Send xview actions to the canvas widget

pathName rtl_tabset ...

Undocumented.

pathName redraw

Used for the entire display stuff, also the contained child widget management widget will be replaced.

pathName selectat x y

Locate the item underneath the mouse cursor.

pathName tab action item ...

Wrapper, access method for the included items. Note the used items need not to be of type rtl_tabItem. The items inside of a rtl_tabset have to be composed of the same template type and cannot being changed after an single item was added to the tabset.

Dependencies

  • rtl

  • rtl_tooltip

  • tkpath

Prev Up Next
Rtl_combobox Home Rtl_mlistbox
SourceForge Logo Gestalt Items