--- name: "collapsablewidget" section: "n" platform: "macos" package: "tcl" version: "152" release: "macOS 26.5" platforms: ["macos"] url: "https://new.carta.tech/collapsablewidget" --- # collapsablewidget(n) Create and manipulate a labeled widget ## NAME iwidgets::collapsablewidget - Create and manipulate a labeled widget ## SYNOPSIS **collapsablewidget** *pathName* ?*options*? ## INHERITANCE itk::Widget \<- iwidgets::collapsablewidget ## STANDARD OPTIONS ``` background cursor foreground ``` See the "options" manual entry for details on the standard options. ## WIDGET-SPECIFIC OPTIONS ``` Name: collapsed Class: Collapsed Command-Line Switch: -collapsed ``` - Specifies whether to hide or display the childsite. Takes a boolean value. If true, the childsite is hidden from view, if false it is displayed. The default is to display the childsite. ``` Name: foreground Class: Foreground Command-Line Switch: -foreground ``` - Specifies the foreground to be used in the label. ``` Name: labelBitmap Class: Bitmap Command-Line Switch: -labelbitmap ``` - Specifies a bitmap to display in the widget, in any of the forms acceptable to **Tk\_GetBitmap**. This option overrides the *labeltext* option. ``` Name: labelFont Class: Font Command-Line Switch: -labelfont ``` - Specifies the font to be used for the label. ``` Name: labelImage Class: Image Command-Line Switch: -labelimage ``` - Specifies a image to be used as the label. The image may be any of the values created by the **image create** command. This option overrides both the *labelbitmap* and *labeletext* options. ``` Name: labelMargin Class: Margin Command-Line Switch: -labelmargin ``` - Specifies the distance between the childsite and label in any of the forms acceptable to **Tk\_GetPixels**. The default is 2 pixel. ``` Name: labelText Class: Text Command-Line Switch: -labeltext ``` - Specifies the text of the label around the childsite. ``` Name: labelVariable Class: Variable Command-Line Switch: -labelvariable ``` - Specifies the text variable of the label around the childsite. ## DESCRIPTION The **collapsablewidget** command creates a labeled widget which contains a button, a label and child site. The child site is a frame which can filled with any widget via a derived class or though the use of the childsite method. This class was designed to be a general purpose base class for supporting the combination of label widget and a childsite, in which the button (which displays a suitable image) controls whether to display the childsite or not. The options include the ability to modify the font and margin, and control the display of the labels. ## METHODS The **collapsablewidget** command creates a new Tcl command whose name is *pathName*. This command may be used to invoke various operations on the widget. It has the following general form: *pathName option* ?*arg arg ...*? *Option* and the *arg*s determine the exact behavior of the command. The following commands are possible for collapsablewidget widgets: ## WIDGET-SPECIFIC METHODS - *pathName* **childsite** Return the path name of the child site. - *pathName* **cget** *option* Returns the current value of the configuration option given by *option*. *Option* may have any of the values accepted by the **collapsablewidget** command. - *pathName* **collapse** Hides the childsite from view, updating the image in the button to reflect the new state. - *pathName* **configure** ?*option*? ?*value option value ...*? Query or modify the configuration options of the widget. 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 widget 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 **collapsablewidget** command. - *pathName* **reveal** Bring the childsite into view, updating the image in the button to reflect the new state. - *pathName* **toggle** If the childsite is in view, hide it, and if it is hidden display it. Updates the image in the button to reflect the new state. ## STATIC METHODS - **Collapsablewidget::alignlabels** *widget* ?*widget ...*? The alignlabels procedure takes a list of widgets derived from the Collapsablewidget class and uses the label margin to make each widget have the same total space for the combination of label and margin. The net effect is to left align the labels. ## COMPONENTS ``` Name: label Class: label ``` - The label component provides the label for the labeled widget. See the "label" widget manual entry for details on the label component item. ``` Name: lwchildsite Class: frame ``` - The lwchildsite component is the user child site for the labeled widget. See the "frame" widget manual entry for details on the lwchildsite component item. ## EXAMPLE - The collapsablewidget is useful when you wish to display a large amount of information in a single window, only some of which the user is likely to want to see at any one time. By placing a number of collapsable widgets in the window, each of which contains some of the available information (presumably categorised appropriately), you can make very effective use of a small amount of screen real-estate. The following is an example of how to create a widget which has its childsite hidden, and then reveal the childsite later. iwidgets::collapsablewidget .cw -labeltext "Canvas Widget" -collapsed 1\ pack .cw -fill both -expand yes -padx 10 -pady 10 set cw \[canvas \[.cw childsite\].c -relief raised -width 200 -height 200\]\ pack $cw -padx 10 -pady 10\ after 2000 {.cw reveal} ## AUTHOR Vince Darley ## KEYWORDS collapsablewidget, widget