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.

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.

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.

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

Change the visibility of the galette toolbar. This function interrelate with property »hideTitle«. The toolbar stays visible when hideTitle is active.

Side effect : Creates displaying synthetic events. Hiding and Showing.

Monitor this events to implement auto- hide/show the content of other galettes. Rewritten : 02/28/2008, Roger Revision : 06/26/2009, Roger-events

pathName ensure interp parentWidget

Queries inside the given »interp« for the »-ensure« property. And thus controls the visibility of all the items inside the contained »toolbar«.

Test if the current items are applicable in the current situation ...

pathName itemcget ...

Forward to »toolbar« itemcget. See also goolbar.

pathName toolbar

Retrieve the contained toolbar ... the toolbar should be filled directly ...

pathName size widget x y ...

Resize the elements inside ...

pathName init

The secondary constructor for template »galette«. Mostly deals with stripes and also floating window customization. Internal used by the template procedure.

pathName drag x y

A Drag-n-Drop operation is under progress. That is, a galette is moved inside of its container. The galette must be managed by grid, for using this code.

pathName fallback

As with every template, the galette supports multiple creation windows. And for that reason a galette may be represented embedded and floating.

For a galette the creation state can be changed after creation. Thus when a floating galette is recreated as an embedded window »fallback« gets called and re-integrates this window into its previous container.

Only for the »grid« geometry manager.

pathName itemconfigure ...

Forwards itemconfigure calls to the internal »toolbar«.

Doesn’t operate on the galette, itself.

pathName sizeMotion widget x y ...

Display a resize operation. See also »resize«

pathName resize widget x y ...

Normally »resize« operations should be done on the parent level. This is however –for some picky reasons— not done here. Therefore resize is an internal function of the galette.

pathName invoke type name ...

Executes the global »-command« property for the item »type« and applies »name« and »args« to the invoke call.

This call can be omitted, when the »toolbar« item features a non-standard »-command«.

pathName drop x y

Palette is moved inside parent to another cell.

When the palette gets moved, determine in which row/ column it was placed to.

Calls »occupied« in order to tidy-up the grid of its container window.

pathName tearoff x y ...

Counterpart to »fallback«. »tearoff« is called for an embedded galette, in order to convert it into a floating window. The coordinates »x, y« denote the place of the left and top corner of the created floating galette.

The »fallback« procedure is registered for the window destroy command. The window will be re-managed when it is supposed to be destroyed.