You are here: Surpac Concepts > Macros > SCL > GUIDO > GUIDO Object Methods
GEOVIA Surpac

GUIDO Object Methods

Object methods are functions (procedures) that can be called on a Guido Widget or Container at runtime to invoke some action. When using call-back procedures you will inevitably require the use of object methods to retrieve information and to manipulate objects in some manner. Some Guido objects such as the GuidoTree require explicit use of object methods to enable functionality as do many of the browser objects such as the GuidoEntityBrowserField.

The standard syntax for invoking an object is as follows

$objectName methodName [arguments]
where

  • objectName is the name you assigned to the Guido object
  • methodName is the name of the method you wish to invoke
  • arguments are any parameters that the method may require

Many object methods will directly correspond to Guido Switches while others offer functionality not available through the static switch mechanism. The table below describes the object methods in logical categories and provides simple examples to help you with their use.

General Guido Object Methods

$objectHandle getObject getObject returns a reference handle to the Java class behind the Guido object. Any native Java class method for the object can then be called. Caution should be exercised with this method as future compatibility is not guaranteed. See the java documentation for detailed information on java classes.
set javaClass [$guidoObj getObject]
$objectHandle getName getName returns the name of the object as assigned in the form definition
set name [$guidoObj getName]
$objectHandle getProc getProc returns the name of the Tcl procedure associated with the command
set procName [$guidoObj getProc]
$objectHandle getType getType returns the Java class name of the Guido object
set className [$guidoObj getType]
$objectHandle setLabel GuidoLabelObject setLabel will set a new GuidoLabel object for this object. Note that this is not text but an actual GuidoLabel object
$objectHandle setLabel $labelObj
$objectHandle getLabel getLabel returns the current label object associated with this object
set labelObj [$guidoObj getLabel]
$objectHandle getLabelText getLabel returns the current text label associated with this object
set label [$guidoObj getLabelText]
$objectHandle setNoMLT true|false setNoMLT returns the current text label associated with this object. The software endeavours to convert text labels into the current language using the Multi Lingual Translator (MLT). Setting the NoMlt method to true will prevent the MLT from translating text values specified for the object.
$objectHandle setNoMLT true
$objectHandle setHeight setHeight will set a new height for the object
$guidoObj setHeight 2
$objectHandle getHeight getHeight returns the current height of this object
set height [$guidoObj getHeight]
$objectHandle setWidth setWidth will set a new width for the object
$guidoObj setWidth 25
$objectHandle getWidth getWidth returns the current width of this object
set width [$guidoObj getWidth]
$objectHandle setFontHighlight red green blue setFontHighlight allows you to set the rgb component to render the object in. Rgb values are specified in the range 0 to 255
$guidoObj setFontHighlight 255 0 127
$objectHandle setFontStyle plain/bold/italic setFontStyle allows you to set the rendering style for the object
$guidoObj setFontStyle bold
$objectHandle getFontStyle getFontStyle returns the current rendering style for this object
set fontStyle [$guidoObj getFontStyle]
$objectHandle setTip setTip sets the help text for the object
$guidoObj setTip "My custom tooltip"
$objectHandle getTip getTip returns the current help text for the object
set helpText [$guidoObj getTip]
$objectHandle setInputAllowed true|false setInputAllowed allows you to set the object for input focus.
$guidoObj setInputAllowed false
$objectHandle isInputAllowed isInputAllowed returns the current input state of the object as a boolean (1|0) value. The value 0 represents false and the value 1 represents true.
set inputEnabled [$guidoObj isInputAllowed]
$objectHandle setNextFocusableComponentName name setNextFocusableComponentName allows you to specify the name of the next object to gain focus after this object, ie the next object in the Tab order.
$guidoObj setNextFocusableComponentName gradeValue
$objectHandle getNextFocusableComponentName getNextFocusableComponentName returns the name of the object which is next in the Tab order (next object to get focus)
set next [$guidoObj getNextFocusableComponentName]
$objectHandle setIconByName iconPath setIconByName sets the icon to be used by this object. Icons are referenced from the SSI_RESOURCES: logical (usually the /ssi_Vx.x-r/share/resource directory). You must include any sub directory prefix as well like icon/ in the example below.
$guidoObj setIconByName icons/next_section.gif
$objectHandle getIconName getIconName returns the relative pathname (from SSI_RESOURCE:) of any icon set on this object
set iconPath [$guidoObj getIconName]
$objectHandle setVisible true|false setVisible turns the visibility of an object on or off
$guidoObj setVisible false
$objectHandle getVisible getVisible returns a boolean value indicating if the object is currently visible or not. The value 0 represents false and the value 1 represents true.
set visible [$guidoObj getVisible]
$objectHandle setLayoutConstraint constraint setLayoutConstraint allows you to position an object within a container managed by the BorderLayout Manager. The constraint can be one of North, South, East, West, or Center.
$guidoObj setLayoutConstraint North
$objectHandle
getLayoutConstraint
getLayoutConstraint returns the current layout constraint of an object
set constraint [$guidoObj getLayoutConstraint]
$objectHandle addAction actionType actionExpr addAction allows you to set an action call-back or expression for the object
$guidoObj addAction valueChanged {[updateForm]}
$objectHandle getActions getActions returns a Tcl list of all action expressions set on this object
set actions [$guidoObj getActions]
$objectHandle addDependency actionType actionExpr addDependency allows you to set a dependency call-back or expression for the object
$guidoObj addDependency {[plotScaleDep $plotNow]}
$objectHandle getDependencies getDependencies returns a Tcl list of all dependency expressions set on this object
set actions [$guidoObj getActions]
$objectHandle addValidation validationExpr addValidation allows you to set a validation call-back or expression for the object
$guidoObj addValidation {[valueInRange]}
$objectHandle getValidations getValidations returns a Tcl list of all validation expressions set on this object
set actions [$guidoObj getValidations]

 

Guido Container Methods

$container setBorder style labelsetBorder allows you to set the border style for a container and whether the associated label text is included in the border. Permitted values for style are empty, etched, loweredBevel, or raisedBevel. Permitted values for label are true or false.
$panel setBorder etched true
$container setBorderTitleAlignment alignmentsetBorderTitleAlignment allows you to place the border title (label) on the left side, centre, or right side of the border. The default is to place the title to the left side of the border. Permitted values for alignment are left, center, or right.
$panel setBorderTitleAlignment center
$container setBorderTitlePosition positionsetBorderTitlePosition allows you control over where the title is positioned relative to the actual border lines. The options are:
  • above_top - place the title on the top border of the container above the border line
  • top - place the title on the top border of the container centred within border line (default)
  • below_top - place the title on the top border of the container below the border line
  • above_bottom - place the title on the bottom border of the container above the border line
  • bottom - place the title on the bottom border of the container centred within border line
  • below_bottom - place the title on the bottom border of the container below the border line
$panel setBorderTitlePosition above_top
$container add objectHandleadd allows you to insert a new object into this container. How the object is inserted depends upon the type of container
$panel add $fieldHandle
$container remove objectHandleremove allows you to remove the given component from the container.
$panel remove $labelHandle
$container setLayout layoutManager [options]setLayout allows you to set the layout manager for the container. Usually you would only do this for a GuidoPanel object. See Layout Managers for further information.
$panel setLayout BoxLayout Y_AXIS
$container getLayoutgetLayout returns a handle to the actual layout manager object.
set layoutHandle [$panel getLayout]

Guido Widget Methods

$widgetHandle getCurrentValue [rowNo]getCurrentValue returns the current value of a widget. If the widget is part of a GuidoTable then the value of the current row is returned unless the optional rowNo argument is given to specify the row number that you want the value of. Row numbers in tables begin from 0. If you specify a row index that is outside the valid bounds you will receive a warning message but the callback will continue to process.
set value [$field getCurrentValue]
set value [$field getCurrentValue 4]
$widgetHandle getCurrentValueRelative referencegetCurrentValueRelative returns the value of a widget in a GuidoTable relative to the current row in the table. The reference can be positive or negative. If the relative reference is out of bounds a blank value is returned.
set prevValue [$field getCurrentValueRelative -1]
$widgetHandle setCurrentValue value [rowNo]setCurrentValue allows you to set the value for a widget. If the widget is part of a GuidoTable then the value is set for the current row unless the optional rowNo argument is given to specify the row number that you want to set the value of. Row numbers in tables begin from 0. If you specify a row index that is outside the valid bounds you will receive a warning message but the callback will continue to process.
$field setCurrentValue "pit"
$field setCurrentValue "level" 6
$widgetHandle setCurrentValueRelative value referencesetCurrentValueRelative allows you to set the value of a widget in a GuidoTable relative to the current row in the table. The reference can be positive or negative. If the relative index is out of bounds no action is taken.
$field setCurrentValue "[$field getCurrentValue]" 1
$widgetHandle setDefault valuesetDefault allows you to set a default value for a widget
$intField setDefault 0
$txtField setDefault "North"
$widgetHandle setFormat formatTypesetFormat allows you to set the format type for a field. The different format specifiers are discussed in the description of the -format switch.
$field setFormat integer
$widgetHandle getFormatgetFormat returns the current format type of a widget
set type [$field getFormat]
$widgetHandle setHighBound valuesetHighBound sets the high bound validation limit for a widget.
$field setHighBound 100
$widgetHandle getHighBoundgetHighBound returns the high bound validation limit for a widget.
set upperLimit [$field getHighBound]
$widgetHandle setLowBound valuesetLowBound sets the low bound validation limit for a widget.
$field setLowBound 0.0
$widgetHandle getLowBoundgetLowBound returns the low bound validation limit for a widget.
set lowerLimit [$field getLowBound]
$widgetHandle setNullAllowed true|falsesetNullAllowed determines whether a widget can have a null value
$field setNullAllowed false
$widgetHandle isNullAllowedisNullAllowed returns the current null setting for a widget
set nullValues [$field isNullAllowed]

GuidoField, GuidoPasswordField, GuidoComboBox Methods

$widgetHandle setMaximumLength lengthsetMaximumLength allows you to set the maximum number of characters that can be entered into a text entry area
$fieldHandle setMaximumLength 10
$widgetHandle getMaximumLengthgetMaximumLength returns the maximum number of characters that can be entered into this field
set len [$fieldHandle getMaximumLength]
$widgetHandle setTranslate modesetTranslate allows you to specify if the case of characters is to be automatically converted when they are typed into a text entry area. Permitted values for mode are upper, lower, mixed, and none.
$fieldHandle setTranslate upper
$widgetHandle getTranslategetTranslate returns the current translation setting for text entry
set case [$fieldHandle getTranslate]
$widgetHandle setFileAccess modesetFileAccess allows you to set a file checking validation for the widget. Valid settings for mode are read, write, and exist.
$fieldHandle 
$widgetHandle getFileAccessgetFileAccess returns the current file access mode setting for this widget
set mode [$fieldHandle getFileAccess]

GuidoComboBox & Specialist Browser Methods

$comboBoxHandle addItem itemaddItem adds an item to the list of values for the combo box.
$comboBoxHandle addItem "A0"
$comboBoxHandle setExclusive true|falsesetExclusive allows you to set the combo box as exclusive or unexclusive
$comboBoxHandle setExclusive false
$comboBoxHandle isExclusiveisExclusive returns true or false to indicate if the combo box is exclusive or not
set exclusivity [$comboBoxHandle isExclusive]
$comboBoxHandle getItemAt positiongetItemAt returns the item at the given position in the combo box list. Note that item positions begin at 0
set anItem [$comboBoxHandle getItemAt 0]
$comboBoxHandle removeItem itemremoveItem will remove the given item form the combo boxes value list
$comboBoxHandle removeItem "A0"
$comboBoxHandle removeItemAt positionremoveItemAt will remove the item at the given position in the combo box list. Note that item positions begin at 0
$comboBoxHandle removeItemAt 3
$comboBoxHandle removeAllItemsremoveAllItems will clear all entries in the combo boxes value list
$comboBoxHandle removeAllItems
$comboBoxHandle setAlternativeValues val1 [val2 ... valn]setAlternativeValues allows you to set a different set of display values for the combo box list. Note that this is only for the display list and it is the values that are set using the value_in switch that are returned to your script.
$comboBoxHandle setAlternativeValues "Big" "Med" "Sml"
$comboBoxHandle setValuessetValues allows you to set the list of selectable values on a combo box. Simply list the values behind the switch separated with spaces. If you want a space to be included in an item value then the whole value must be enclosed in double quotes
$comboBoxHandle setValues A0 A1 A3 A4
$comboBoxHandle setMaximumRowCountsetMaximumRowCount allows you to set the maximum size of the displayed list. Note this is the number of items that can be displayed on the screen not the number of items allowed in the list.
$comboBoxHandle setMaximumRowCount 5
$comboBoxHandle getMaximumRowCountgetMaximumRowCount returns the maximum size of the popup window that displays the list items
set popupSize [$comboBoxHandle getMaximumRowCount]
$browserHandle setSortedList true|falsesetSortedList allows you to specify whether the list of values is sorted in alphabetical order to help with the combo boxes (or other browser) list searching techniques. By default the list is assumed to be unsorted and a linear search technique is used. When you have extremely large lists that are sorted, by specifying that the list is sorted you direct the combo box to use a binary search technique that is orders of magnitude faster than the linear method.
The method is more typically used with a GuidoDatabaseColumnBrowser which is a special implementation of a combo box that allows for all values in a database column to be inserted into a list
$browserHandle setSortedList true
$browserHandle setSharedList browserNamesetSharedList is used when two or more combo boxes wish to share the same list of values in memory. It is used to save memory space and to increase performance when you have extremely large lists of values where two or more combo boxes on the form have the same list of values. It is more typically used with a GuidoDatabaseColumnBrowser which is a special implementation of a combo box that allows for all values in a database column to be inserted into a list. To share the list the second and subsequent combo boxes specify the name of the GuidoComboBox (or other browser) that has the original list defined on (browserName). The example below assumes the original combo box was called firstStation
$browserHandle setSharedList firstStation

GuidoFileBrowserField Methods

$fbHandle setBrowserType file|directorysetBrowserType determines if the file browser is a normal file browser (the default) or a directory browser.
$dirBrowser setBrowserType directory
$fbHandle getBrowserTypegetBrowserType returns the type of browser as either file or directory
set mode [$filename getBrowserType]
$fbHandle setStartDir pathnamesetStartDir allows a particular directory pathname or logical name to be specified as the startup directory for the browser. Note that this does not change the current working directory.
$filename setStartDir SSI_PLOTTING:
$fbHandle getStartDirgetStartDir returns the name of any set startup directory. This maybe a physical path or logical name
set startIn [$filename getStartDir]
$fbHandle setFileMask mask1 [mask2 ...]setFileMask allows you to specify the file masks (extensions) that the browser is allowed to show. All files not matching the specified extensions will be filtered out.
$filenamesetFileMask "*.str" "*.dtm"
$fbHandle getFileMaskgetFileMask returns a list of all the possible file extensions
set masks [$filename getFileMask]
$fbHandle setLink idField [extensionField]setLink allows the selected file to be broken up into the traditional Surpac location and Id pairs. The options extensionField argument also permits the file extension to be placed into a field.
$location setLink id
$fbHandle getLinkField1getLinkField1 returns the name of the field that the browser links to for the id of the filename
set idName [$location getLinkField1]
$fbHandle getLinkField2getLinkField2 returns the name of the field that the browser links to for the extension of the filename
set extName [$location getLinkField2]
$fbHandle setMultipleSelection true|falsesetMultipleSelection allows you to set the browser into multiple file selection mode by specifying true. The default is that browsers work in mono selection mode, the false setting.
$strFiles setMultipleSelection true
$fbHandle isMultipleSelectionisMultipleSelection returns true if the browser is in multiple selection mode, false otherwise.
$filename
$fbHandle setRelativePath true|falsesetRelativePath determines if returned pathnames are in absolute format or are relative to the current working directory. Select true for relative pathnames
$filename setRelativePath true
$fbHandle isRelativePathSetisRelativePathSet returns true if relative pathnames are returned and false if absolute pathnames are returned.
set mode [$filename isRelativePathSet]
$fbHandle setExtension true|falsesetExtension determines whether the file extension is trimmed from the return filename. Set true to leave the extension intact or false to trim it off.
$filename setExtension true
$fbHandle isExtensionSetisExtensionSet returns true if the file extension is left on or false if it is trimmed off.
set ext [$filename isExtensionSet]

 

GuidoButton, GuidoToggleButton, GuidoRadioButton, and GuidoCheckBox Methods

$button setCaptionsetCaption sets some extra text to be placed with the button or checkbox
$button setCaption "Yes"
$button getCaptiongetCaption returns any caption text that has been set on the button
set text [$button getCaption]
$button setSelected true|falsesetSelected with a true value will select the button or check a checkbox.
$button setSelected true
$button isSelectedisSelected returns 1 for true and 0 for false according to the buttons selected state
set isOn [$button isSelected]
$button setSelectedValue valuesetSelectedValue allows you to set the value to be returned when the button or checkbox is selected
$button setSelectedValue "On"
$button setUnselectedValue valuesetUnselectedValue allows you to set the value to be returned when the button or checkbox is not selected
$button setUnselectedValue "Off"
$button setSelectedIconByName iconPathsetSelectedIconByName allows you to insert a gif/jpg/png image icon into the button for display when the button is selected. The pathname is relative to the standard SSI_RESOURCES: logical.
$button setSelectedIconByName icon/on.gif
$button setUnselectedIconByName iconPathsetUnselectedIconByName allows you to insert a gif/jpg/png image icon into the button for display when the button is unselected. The pathname is relative to the standard SSI_RESOURCES: logical.
$button setUnselectedIconByName icon/off.gif
$button getSelectedIconNamegetSelectedIconName returns the resource path of any set selected icon resource
set onPath [$button getSelectedIconName]
$button getUnselectedIconNamegetUnelectedIconName returns the resource path of any set unselected icon resource
set offPath [$button getUnelectedIconName]
$button setCaptionPlacementsetCaptionPlacement allows you to specify where to place the caption text associated with a button or checkbox. Permitted values are left, right, top, and bottom.
$button

GuidoButtonGroup Methods

$buttonGroup getButtonCountgetButtonCount returns the number of buttons that are contained within a button group
set buttonCount [$buttonGroup getButtonCount]

GuidoChart Methods

$chartHandle drawChartdrawChart will cause the chart to be drawn using all the current set categories and values
$chartHandle drawChart
$chartHandle setChartType typesetChartType determines the type of chart to draw. The type must be one of the types listed below
  • "Bar"
  • "3D Bar"
  • "Stacked Bar"
  • "3D Stacked Bar"
  • "Area"
  • "Stacked Area"
  • "Line"
  • "Multiple Pie"
  • "3D Multiple Pie"
  • "Waterfall"
  • "Area XY"
  • "Line XY"
  • "Polar"
  • "Scatter"
  • "Time Series"
  • "Step Area XY"
  • "Step XY"
  • "Pie"
  • "3D Pie"
  • "Bubble"
$chart setChartType "Line"
$areaChart setChartType "Stacked Area"
$chartHandle setLegend true|falsesetLegend determines if legends are drawn (true) or not drawn (false)
$chart setLedgend true
$chartHandle setXAxisLabel labelsetXAxisLabel determines whether a label is drawn underneath the X axis on the chart. You need to supply the label
$chart setXAxisLabel "Samples"
$chartHandle setYAxisLabel labelsetYAxisLabel determines whether a label is drawn next to the Y axis on the chart. You need to supply the label
$chart setYAxisLabel "Depth"
$chartHandle setChartTitle tittlesetChartTitle determines whether a title is drawn above the chart graphic.
$char setChartTitle "Depth v Samples"
$chartHandle setCategoryValue cat xVal yValsetCategoryValue will set a category to display on the chart along with an x axis and y axis value. Note that it only sets one value per category. To set a number of values for the category multiple object method calls must be made

This method is used to set values for bar, line, and pie style charts

$chartHandle setCategoryValue "ABC" 1 20
$chartHandle setCategoryValue "ABC" 2 30
$chartHandle setCategoryValue "ABC" 3 5
$chartHandle setXYValue cat xVal yValsetXYValue will set an xy value to plot onto chart. The category cat associates the value with a particular set of values. Note that it only sets one chart value per category. To set a number of values for the category multiple object method calls must be made

This method is used to set values for scatter, polar, area, and line xy style charts

$chartHandle setXYValue "RL" 1 1600
$chartHandle setXYValue "RL" 2 1625
$chartHandle setXYValue "RL" 3 1650
$chartHandle setXYZValue cat xVal yVal zValsetXYZValue will set an xyz value to plot onto a chart. The category (cat) associates the values with a particular set of values. Note that it only sets one chart value per category. To set a number of values for the category multiple object method calls must be made

This method is used to set values for bubble of charts

$chartHandle setXYZValue "particle" 1 0.1 1.2
$chartHandle setXYZValue "particle" 2 0.1 0.6
$chartHandle setXYZValue "particle" 3 0.3 0.9
$chartHandle setPieValue cat valsetPieValue will set a category along with its value on a pie chart. To set a values for each category multiple object method calls must be made

This method is used to set values for pie style charts.

$chartHandle setPieValue "Above" 20
$chartHandle setPieValue "Mean" 50
$chartHandle setPieValue "Below" 30

GuidoSlider Methods

$slider setOrientation Horizontal|VerticalsetOrientation determines the direction of the slider which may Horizontal (the default) or Vertical
$slider setOrientation Vertical
$slider getOrientationgetOrientation returns the direction of the slider as horizontal or vertical
set direction [$slider getOrientation]
$slider setLegend incrementsetLegend allows a legend to be drawn on the slider with the nominated increment values. The legend will begin at the minimum value set and end at the maximum value set
$slider setLegend 5
$slider setMajorTicks valuesetMajorTicks determines the interval to draw major tick marks on the slider. Major tick marks appear as longer lines than minor tick marks. You must also specify paintTicks true for tick marks to be drawn.
$slider setMajorTicks 25
$slider getMajorTicksgetMajorTicks returns the value for the major tick marks
set majors [$slider getMajorTicks]
$slider setMinorTicks valuesetMinorTicks determines the interval to draw minor tick marks on the slider. Minor tick marks appear as short lines between any major tick marks on the slider. You must also specify paintTicks true for tick marks to be drawn.
$slider setMinorTicks 5
$slider getMinorTicksgetMinorTicks returns the value for the minor tick marks
set minors [$slider getMinorTicks]
$slider setMinimum valuesetMinimum determines the start value for the slider. It is specified in tenths of a unit, that is the value 1 equates to 0.1, the value 10 equates to 1, the value 100 equates to 10, etc. The default value of 0 is used if no minimum is specified.
$slider setMinimum 500
$slider setMaximum valuesetMaximum determines the end value for the slider. It is specified in tenths of a unit, that is the value 1 equates to 0.1, the value 10 equates to 1, the value 100 equates to 10, etc. The default value of 1000 (equates to 100) is used if no maximum is specified.
$slider setMaximum 5000
$slider setStatusItem namesetStatusItem associates the slider value with a status item
$slider setStatusItem "Scale"
$slider setIncrement valuesetIncrement set the increment value for updating the status item
$slider setIncrement 10
$slider addIncrementaddIncrement causes the status item displayed to be incremented and updated
$slider addIncrement
$slider takeIncrementtakeIncrement causes the status item displayed to be decremented and updated
$slider takeIncrement

GuidoScrollPane Methods

$scrollPane setScrollSize width<</i> heightsetScrollSize sets the width and height of the scrolling region that includes row and column headers. The values are specified in character width and height based on the M character.
$tableScroller setScrollSize 10

GuidoSplitPane Methods

$splitPane setOrientation HORIZONTAL_SPLIT|VERTICAL_SPLITsetOrientation determines if the split pane is horizontal or vertical
$splitPane setOrientation HORIZONTAL_SPLIT
$splitPane getOrientationgetOrientation returns either HORIZONTAL_SPLIT or VERTICAL_SPLIT depending on the orientation of the split pane
set orientation [$splitPane getOrientation]
$splitPane setDividerLocation positionsetDividerLocation specifies where to place the visible divider. It can be specified as a percentage of the available space or as an actual width or height value depending on orientation that is measured in pixels.
$splitPane setDividerLocation 25%
$splitPane getDividerLocationgetDividerLocation returns the current position of the divider as a width or height value depending on orientation that is measured in pixels
set pos [$splitPane getDividerLocation]
$splitPane setExpandable true|falsesetExpandable determines whether a set of small triangle icons are placed on the divider to allow each side of the split pane to be quickly collapsed or expanded.
$splitPane setExpandable true
$splitPane isExpandableisExpandable returns true (1) or false (0) depending on whether the divider contains the one touch triangle icons that allow the split pane to be quickly collapsed or expanded.
set expandable [$splitPane isExpandable]
$splitPane setContinuousLayout true|falsesetContinuousLayout determines whether the split pane layout manager should reposition the objects in each section as the user resizes by moving the divider or resizing the form. True indicates that objects should be repositioned.
$splitPane setContinuousLayout false
$splitPane isContinuousLayoutisContinuousLayout returns a boolean true or false on the continuous state of the split pane
set isContinuous [$splitPane isContinuousLayout]

GuidoTabbedPane Methods

tabbedPane getPaneNamegetPaneName returns the string representation of a tabbed pane
set paneName [$tabbedPane getPaneName]
tabbedPane - This is a tabbedPane object 
paneName - This is a string variable that 
 saves the tabbed pane name
tabbedPane getProcName $indexgetProcName returns the Jacl procedure name for the panel object at a specified index
set procName [$tabbedPane getProcName $index]
tabbedPane - This is a tabbedPane object 
index - This is the index, starting at 0, 
 to define the tabbed pane whose name
 has to be obtained
procName - This is a string variable that 
 saves the Jacl procedure name
tabbedPane getSelectedIndexgetSelectedIndex returns the index number of the selected tab in the pane. Note that the first tab is index 0
set selected [$tabbedPane getSelectedIndex]
tabbedPane getTabCountgetTabCount returns the number of tabs in the pane
set count [$tabbedPane getTabCount]
tabbedPane getTitleAt indexgetTitleAt returns the title of the object at the given tab index
set title [$tabbedPane getTitleAt 2]
tabbedPane insertTabAt index $objectinsertTabAt sets a new object (normally a GuidoPanel) into the tabbed pane at the given index number
$tabbedPane insertTabAt 3 $plotParams
tabbedPane removeTabAt indexremoveTabAt will remove the object at the given tab index position
$tabbedPane removeTabAt 3
tabbedPane setSelectedIndex indexsetSelectedIndex sets the tab index to be selected (at the top)
$tabbedPane setSelectedIndex 2
tabbedPane setTabbedPane $index $statesetTabbedPane allows you to enable or disable a tabbedpane whose index is given
$tabbedPane setTabbedPane $panelIndex $state
tabbedPane - This is a tabbedPane object 
panelIndex - This is the index, starting at 0, 
 to define the tabbedpane that has 
 to be enabled or disabled
state - true makes the pane active, false makes
 the pane inactive.
tabbedPane setTabPosition top|bottom|left|rightsetTabPosition determines where the tabs appear. By default tabs appear at the top of the pane
$tabbedPane setTabPosition bottom
tabbedPane setTitleAt index titlesetTitleAt allows you to specify the title to appear in the tab at the given index number
$tabbedPane setTitleAt 0 "The First tab"

GuidoTable Methods

$tableHandle setInteractive true|falsesetInteractive determines whether rows can be added and deleted from the table by the script user. Setting interactive to true will allow the user to add rows to the table when the tab key is pressed on the last field of the last row. A popup menu with options to add and delete rows is also available by right clicking the mouse on the row headers. When interactive is set to false the table cannot exceed the maximum row count set.
$tableHandle setInteractive false
$tableHandle getInteractivegetInteractive returns true (1) if the table is interactive and false (0) otherwise
set state [$tableHandle getInteractive]
$tableHandle setInitialRows initial [minimum [maximum]]setInitialRows determines the dynamics of the table by specifying integer values for the parameters as follows
  • initial determines the number of rows to initially be created in the table
  • minimum determines the minimum number of rows that are allowed in the table
  • maximum determines the maximum number of rows that are allowed in the table
When the table is in interactive mode the user cannot remove less than the minimum number of rows or add more than the maximum number of rows.

The minimum and maximum parameters are optional. If they are not specified the minimum number of rows is 0 with no practical maximum.

$tableHandle setInitialRows 1 1 100
$tableHandle addRows rowsaddRows will add the specified number of rows to the table
$tableHandle addRows 10
$tableHandle setRowHeadingssetRowHeadings allows you to change the default row headings. Normally row headings are automatically generated and are numbered from one for each row. By specifying a space separated list of headings you can provide your own custom labels
$tableHandle setRowHeadings A B C D E F G H I J
$tableHandle setRowHeadingsVisible true|falsesetRowHeadingsVisible allows you to turn row headings off by specifying a value of false. By default row headings are shown.
$tableHandle setRowHeadingsVisible false
$tableHandle setRowHeight heightsetRowHeight allows you to set the height for the row heading
$tableHandle setRowHeight 2
$tableHandle getRowCountgetRowCount returns the current number of rows in the table
set rows [$tableHandle getRowCount]
$tableHandle getEditingRowgetEditingRow returns the row number of the cell currently being edited
set row [$tableHandle getEditingRow]
$tableHandle getColumnCountgetColumnCount returns the number of columns in the table
set cols [$tableHandle getColumnCount]
$tableHandle getEditingColumngetEditingColumn returns the column number of the cell currently being edited
$tableHandle getEditingColumn
$tableHandle setEditingCell row columnsetEditingCell allows you to set the current cell in the table by specifying a row and column index. Note that indexes are referenced from 0.
$tableHandle setEditingCell 9 0
$tableHandle setColumnSort true|falsesetColumnSort determines whether column sorting is permitted. By default column sorting is set to true which allows the user to sort values within columns in ascending order by clicking the mouse on the column header.
$tableHandle setColumnSort false
$tableHandle setBlankRowHeadings true|falsesetBlankRowHeadings allows you to remove the default numbers from the row headers. The row header will still be present but it will not contain any labels
$tableHandle setBlankRowHeadings false

See Also

Guido
Dependency Callbacks
Action Callbacks
Validation Callbacks
Common guido switches