Zoolbar

Zoolbar
Prev	Appendix A. Reference	Next

Runtime Library Options

-creator

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

-activebackground, -activeborderwidth, -activeforeground, -background, -borderwidth, -disabledforeground, -foreground, -relief, -selectcolor, -orient: See the options manual entry for details on the standard options.

Window-specific Options

Command-Line Name: -usetoken, Database Name: useToken, Database Class; -

»useToken« activates the glyph vector graphics system implemented in the toolbar. If »useToken« is set to »1« (true), then the item property »iconFont« is evaluated and the provided image substituted through the glyph given by the property: »token«.

The item properties »bgImage« and »image« are recessive to »token«, whenever »useToken« is set.

Command-Line Name: -usegrid, Database Name: useGrid, Database Class; -

»useGrid« tells the toolbar to place each item aligned on a grid defined by »gridSize«.

Command-Line Name: -gridsize, Database Name: gridSize, Database Class; -

»gridSize« expects a distance denoting the size of a cell. An item may occupy one or more of such cells.

»gridSize« is used in a fuzzy-like way. If the dimensions of neighboring items are small in compared to the actual item, then the actual item may share some space from its neighbors. The same applies if the actual item is small compare to the neighboring items –it does yield some space to them.

Command-Line Name: -showimage, Database Name: showImage, Database Class; -

»showImage«, a boolean property, tells the toolbar to display images.

»image« may be »fgImage«, »image« or »token« and »iconFont« or »vector«.

Command-Line Name: -showtext, Database Name: showText, Database Class; -

»showText«, a boolean property, tells the toolbar to display the »label« of all its items.

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

This option must have a proper boolean value, which specifies whether or not the window should include a tear-off entry at the left. The default windows bindings arrange for the window to be torn off when the tear-off entry is invoked.

Command-Line Name: -tearoffcommand, Database Name: tearoffCommand, Database Class; -

If this option has a non-empty value, then it specifies a Tcl command to invoke whenever the window is torn off.

The conventional Runtime Library template mechanism is used for the »tearoff« functionality. That is A torn-off toolbar is converted into a floating window and replaces the original –embedded– window.

Under Construction.

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

Toolbar items may be visible or invisible. This setting is controlled via the »show« property. Suppose there are four items inside the toolbar named »a«, »b«, »c« and »d« in this situation all items will be initial visible –right after they were added to the toolbar, unless »show« was specified prior to the add commands.

Example A.18. Implicit Visible Items


    # Create the toolbar without specifying
    # show makes all added items visible.

    .toolbar add command a …
    .toolbar add command b …
    .toolbar add command c …
    .toolbar add command d …

Example A.19. Explicit Visible Items


    # Example hide d – and add variable space (~)
    .toolbar configure -show {a b ~ c}

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

The »title« property is only used for a free-floating toolbar. The text property »title« is used as the caption for the created toplevel window.

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

A boolean property. Either 0 or 1. Default is 0 (false/off). Tells the toolbar to break the items into multiple lines.

In addition, line break can be controlled by defining »columnbreak« for an item.

Command-Line Name: -usemenu, Database Name: useMenu, Database Class; -

»useMenu« expects a boolean value. if »useMenu« is set to »1« (true) then a context menu will presented after a <<Context>> (a right-button-click) occured. Do also use »customizeCommand« together with »useMenu«.

Command-Line Name: -hidecommand, Database Name: hideCommand, Database Class; -

The »hideCommand« is used inside the toolbar context menu. The conventional response to this command is to invoke the »Hide Toolbar« menu entry in the »View« menu.

Example A.20. Hide Toolbar

# The application Toolbar:
goolbar .toolbar -hidecommand {
   .menubar.view invoke ?index of entry?
}

# The Application Menubar:
menu .menubar
. configure -menu .menubar

# The Menubar entry »View«:
.menubar add cascade \
              -label "View" \
               -menu .menubar.view

# The »Hide Toolbar« command inside the
# »View« menu: Record the index of this
# command:
.menubar.view add command \
              -label "Hide Toolbar"
            -command ...

Command-Line Name: -customizecommand, Database Name: customizeCommand, Database Class; -

A toolbar customization function.

The »customizeCommand« will be accessible from the toolbar context menu.

Use the »customizeCommand« in order to invoke the Gooleditor for this toolbar.

Example A.21. Calling a Gooleditor


goolbar .toolbar
       -customizeCommand \
           [list customizeToolbar .toolbar]

proc customizeToolbar toolbar {
     if ![winfo exists $toolbar] return

     # An embedded dialog
     set fmt myicons
                
     # A different embedded dialog for glyphs:
     if [$toolbar cget -useToken] {
        set fmt mytbicons
     }
     
     # Display the toolbar editor inside
     # the parent window.           
     gooleditor [winfo parent $toolbar].custom \
          -goolbar $toolbar -custom $fmt
}

Command-Line Name: -vectorsize, Database Name: vectorSize, Database Class; -

The »vectorSize« is reported to the canvas graphics based vectors.

In the future: Vectors, glyphs and images may become fully interactively resize-able –with a scroll-wheel. This feature requires that all vector graphics originate from TkPath.

It is OK to ignore the size parameter, when creating a vector.

Always use resolution independent values like »24p« –24 points. 24p is the »vectorSize« default value.

The Zoolbar already supports »vectorSize« for images.

Description

The zoolbar command creates a zoolbar window.

Window Command

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

Name

Synopsis

Runtime Library Options

Standard Options

Window-specific Options

Description

Window Command