Greffilters
← Chapter 3. Inspector and Filters →

Name

greffilters — Create and manipulate greffilters windows

Synopsis

          ;; package require greffilters in Tcl/Tk.
          (with-ltk-greffilters
             (make-instance 'greffilters ?options ?))

Runtime Library Options

-creator

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

-foreground, -highlightThickness, -highlightColor, -highlightBackground, -borderWidth, -background, -relief

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

Window-specific Options

Command-Line Name: -categoryvariable, Database Name: categoryVariable, Database Class; -

Tcl Variable, this variable is used to display the name of the selected »Category«. Possible values are: Published, Properties, Events and Geometry. Internal used.

Command-Line Name: -globalconfigurefilteredvariable, Database Name: globalConfigureFilterVariable, Database Class; -

Tcl Variable, this variable lists the filter or read only set for the associated »Inspector« page.

Command-Line Name: -globalbindingsfiltervariable, Database Name: globalBindingsFilterVariable, Database Class; -

Tcl Variable, this variable lists the filter or read only set for the associated »Inspector« page.

Command-Line Name: -globalmapfiltervariable, Database Name: globalMapFilterVariable, Database Class; -

Tcl Variable, this variable lists the filter or read only set for the associated »Inspector« page.

Command-Line Name: -globalgeometryfiltervariable, Database Name: globalGeometryFilterVariable, Database Class; -

Tcl Variable, this variable lists the filter or read only set for the associated »Inspector« page.

Command-Line Name: -globalconfiguredisabledvariable, Database Name: globalConfigureDisabledVariable, Database Class; -

Tcl Variable, this variable lists the filter or read only set for the associated »Inspector« page.

Command-Line Name: -globalbindingsdisabledvariable, Database Name: globalBindingsDisabledVariable, Database Class; -

Tcl Variable, this variable lists the filter or read only set for the associated »Inspector« page.

Command-Line Name: -globalmapdisabledvariable, Database Name: globalMapDisabledVariable, Database Class; -

Tcl Variable, this variable lists the filter or read only set for the associated »Inspector« page.

Command-Line Name: -globalgeometrydisabledvariable, Database Name: globalGeometryDisabledVariable, Database Class; -

Tcl Variable, this variable lists the filter or read only set for the associated »Inspector« page.

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

Tcl Array, this array holds the preference settings.

Description

Figure 3.4. greffilters


Creates the »global« Filters Preference Page.

Properties, events listed here, are suppressed inside the Inspector(n) . The greffilters page provides the same sections as Inspector(n) does . »configure«, »map«, »bindings« and »geometry« are these sections.

The Inspector(n) features a built-in filter mechanism in addition to »greffilters«. This filter is implemented by Gfilter(n) and works as a positive filter–opposit to »greffilters«.

Sections

configure

deals with window properties.

map

deals with template interface defintion.

bindings

deals with window event handler.

geometry

deals with geometry management.

The global filters data originates from certain variables, defined via the »greffilters« interface.

There are two filter modes: hidden and read-only properties. Hidden properties are listed in the top area of »greffilters«–being more important. The read-only properties are disclosed underneath a drawer at the bottom of »greffilters«.

Read-only properties are not available for the »map« page. Does not make sense for the interface definition.

Window Command

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

(option object ?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:

(cget object :option)

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

(configure object ?: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 greffilters command.

(showPublished object )

Display Filters for category »Map«

(substractItem object gistbox kind )

Remove the current selected item, in category »kind« from the »gistbox«.

(init object )

Secondary constructor for template »greffilters«. Most of the inertia will move to the template creation code (geometry and history management). Only, the »stripes« section will remain.

Requires a recreation inside of Gestalt.

(showGeometry object )

Display Filters for category »Geometry«

(showEvents object )

Display Filters for category »Bindings«

(showProperties object )

Display Filters for category »Configure«

(collect object gistbox ?kind? ?category? )

Element of »sort« functionality. Sorting: sort on class is actual easy: just sort the array names. sort on properties does not work, thou. Probably a cross-table is required for this kind of sort. -- sort is related to the listbox. Revision : 12/15/2008, Roger

(map object )

Event handler called in response to <Map>. Restores–and initializes– the displayed data. Sets the »focus« to the first listbox.

(addItem object gistbox kind )

Insert the pending element from »gistbox« to the filters for category »kind«.

(sortnotifier object listbox column style )

Invalidate the entire dialog and thus force the listboxes to re-»collect« their displayed data.

(sortedStyle object gistbox )

Query »gistbox« for what sort mechanism is used, and return »integer« if sorting is set to »none«.

(history object kind )

Put the current category »kind«, for future reference–post mortem–in the option database.

(clean object )

Put the entire dialog in an empty initial state.

(sortedby object gistbox class item ID )

Define the sorting style and the affected »column«.

(restore object )

Populate the listboxes, regarding the current settings. Called from »map«.

(refresh object )

Tell every »listbox« to refresh themselves.

Dependencies

  • gutilities

  • gstripes

  • gstripesMenu

  • rtl

  • rtl_sizer

  • gistbox

  • rtl_mlistbox

← ↖ →
Gfilter ↑ Chapter 4. Customize Tools
SourceForge Logo

Copyright © 2009–2010 Arndt Roger Schneider