Galette

Galette
Prev	Appendix A. Reference	Next

Runtime Library Options

-creator

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

-text, -borderWidth, -relief, -width, -height, -background, -foreground, -highlightColor, -highlightBackground, -highlightThickness, -activeBackground, -activeForeground, -takeFocus: See the options manual entry for details on the standard options.

Window-specific Options

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

The Tcl/Tk package for deployed by this galette.

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

The »require« property isn’t used by the galette and may be abused as an external test condition, stored inside the galette.

The above scenario is, how I do use »require« within my own software. It is not likely to change in the future.

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: -command, Database Name: command, Database Class; -

This »command« fragment is executed when an item in the toolbar is activated. The Goolbar items may have their own independent commands, replacing the galette »command« property.

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

Expression, the result of the »ensure« expression enables or disables all items inside the galette.

»ensure« is deployed by the ensure function. The »ensure« function parameter »parentWidget« is feed via »format« into the »ensure« expression. Thus valid substitution for ensure are »%s« and »%1$s«, place holders for »parentWidget«.

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

»undo« holds a code fragment informing how an action from this particular Galette can be undone.

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.14. 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.15. Explicit Visible Items

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

Command-Line Name: -hidetitle, Database Name: hideTitle, Database Class; -

»-hidetitle« tells the window to unmap an integrated title bar.

For a Galette: the integrated toolbar automatically opens, when the title is hidden.

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: -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.

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.16. 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: -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.17. 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 ...

Description

Galette (Palette): Implements a special-type toolbar. Galette features multiple lines of entries and deploys a gridwin for scrollbar management. The customization and context menu is reused from the toolbar.

Revision : 05/18/2009, Roger 1.1 06/26/2009

The extended interface from the goolbar is used. Focus-Ring and -takefocus management exported via the template interface.

ActiveForeground, ActiveBackground and Highlighting exported via template interface.

Synthetic events on visibility changes.

Revision : 11/19/2009, Roger 1.2 Additional properties from the toolbar mapped into the galette interface. Chiefly to deal with code generation.

Window Command

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

pathName visibility