Inspector
← Chapter 3. Inspector and Filters →

Name

inspector — Create and manipulate inspector windows

Synopsis

          package require inspector
        
          inspector pathName ?options ?

Runtime Library Options

-creator

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

-relief, -borderWidth, -background, -text

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

Window-specific Options

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

A valid Tcl-Interpreter. This interpreter must be created through interp create.

The current Tcl-Interpreter is used whenever the property is left empty.

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

Set the sorting method used inside the Inspector. Possible values are »unsorted«, "increasing" and »decreasing«.

The property »-sort« is usually specified from the Inspector context menu to the right. The property »-sort« is identical to this menu.

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

list of inspected items. The inspected items must be of the same kind.

Command-Line Name: -itemtype, Database Name: itemType, Database Class; -

Informs the »Inspector« about the current type of the inspected »-widgets«.

Known itemTypes are: »canvasitem«, »zincitem«, »canvasgradient«, »zinctransform«, »canvasstyle«, »photo«, »goolbaritem«, »menuitem«, »textitem«, »tabletag« otherwise it defaults to window.

See also inspection.tcl.

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

Command interface for the third page »Events« inside the Inspector.

Expects an command set as described in »-configure« property.

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

Command interface for the first page »Property« inside the Inspector.

The four pages have each an individual command interface identified as »configure«, »geometry«, »bindings« and »map«.

Example 3.1. »configure« Command Set

.inspector \
   -itemtype menuitem \
   -configure {
       {record {gmenuitem %s record %s}}
       {script {gmenuitem %s script %s %s {%s}}}
       {conscr {
           gmenucontext %s %s %s \
               option configure
       }}
       {options {}}
   } ...

As seen in Example 3.1, “»configure« Command Set”, a command set consists of four parts –call back scripts– »record« is used to gather the data for the inspected items. »script« is used to apply changed values to the items. »conscript« is used to collect either the historic values or a closed set of default values.

See also ginspectutilities.tcl.

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

Command interface for the last page »Interface« inside the Inspector.

Expects an command set as described in »-configure« property.

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

Command interface for the second page »Interface« inside the Inspector.

Expects an command set as described in »-configure« property.

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.

Description

Figure 3.1. inspector


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

The Inspector is used to inspect and modify the values of window properties, their geometry, assigns event handlers and defines the template interface.

The Inspector is interrelated with many other dialogs, such as Gfilter(n) ,Greffilters(n) , Gsearch(n) and a vast assortment of property specific editors.

The »Inspector« integrates OptionInfo(n). Editing itself is delegated to a set of OptionItem(n)s. Both templates can be redefined through the option database. The option database entries are ».optionInfo« and ».optionItem«. OptionInfo should be implemented as a template–the »-creator« property is used by the Inspector »Info« method.

options : record : used to get the options for a widget (substitute widget) trascript : traverseScript for control return actions conscript : contextScript script : normal script to setup new value widgets : setup new session for the given widget list options : filter this options (only these options are allowed) size : cnu

Window Command

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

pathName setfilter ...

Apply the »args« as a filter-set to the current edit category.

pathName contextMenu menu

Extracted from template procedure. A dynamic menu is needed, in order to statisfy the Aqua HCI Guidelines.

Checkbuttons are substituted with verbal commands, depending on the value of the inspected variable.

pathName getClassAttributes path class type

–

pathName dump

Dump entire information’s from inspector.

See also : »restore«

pathName options method type ...

New with Minor Release 1. public access method for the built-in filters.

Actual for VisualGIPSY 2.5!

Local storage compartment for »global« filter separated for each »type«.

Internal Function.

pathName showInformation

Event handler for context menu. Needed to emulate checkbuttons. As specified by the Aqua HCI Guidelines.

pathName update

Forces the Inspector »base« to refresh the content it does currently display.

pathName filter

The filter dialog of inspector »base«. A floating global filter window is displayed and filled with predefined items.

The display of the global filter is actualized in case, where it is already visible.

pathName applyglobal

The current value will be used to set each attribute –throughout the complete project– of each suitable window.

pathName tearoff grip_n x y

The inspector gets detached from the main window. Reconfigure the left column (from the inspector).

Side-effect : 10/16/2006 Apply span for the previous column. grant this column to the elements inside the previous column. The internal size won’t change; resulting in cropping, when the main window size is reduced.

pathName disableGlobalFilters

Event handler for context menu. Needed to emulate checkbuttons. As specified by the Aqua HCI Guidelines.

pathName edit type ?modify?

New content editing for listboxs & text windows. See Jeszra for ginspecteditors.

pathName fallback

Ignore the management from the menu. instead do restore the last geometry settings and retrieve all changes done to siblings in the same grid ... The inspector should yield his space to the next window left and top to him -- which are the designated places for the composer.

Note 10/16/2006, Roger : The inspector should be ignorant about it's whereabouts This does not take part here -- have to rethink how-to deal with it! The inspector has to lookup its siblings and reconfigure them to fit in.

Revision : 10/29/2007, Roger

pathName destroy

The destructor of widget hierarchy base. Cleanup everything which was added to the »var« array –old style storage scheme.

pathName restore dump

Restore entire inspector content.

pathName enableGlobalFilters

Event handler for context menu. Needed to emulate checkbuttons. As specified by the Aqua HCI Guidelines.

pathName getInterp

Public access method for the currently active Tcl-Interpreter.

pathName init

Secondary constructor for a Jeszra Inspector window.

Registers an toplevel Inspector as an participant with activate and deactivate. Embedded Inspectors do not –for themeselve partake in activate / deactivate.

pathName Info

Show the info area w(7).

Creates/Recreates the information area. This area is normally created by the »optionInfo« template, the data inside this template is accessed and stored for later.

pathName hideInformation

Event handler for context menu. Needed to emulate checkbuttons. As specified by the Aqua HCI Guidelines.

pathName switchto category

Change the the inspector »category«.

To-Do : Review »set-widgets« for exception!

Dependencies

  • gutilities

  • ginspecteditors

  • gstripesMenu

  • gfilter

  • traverso

  • optionInfo

  • optionItem

← ↖ →
Chapter 3. Inspector and Filters ↑ OptionItem
SourceForge Logo

Copyright © 2009–2010 Arndt Roger Schneider