Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkKWCheckButton Class Reference

check button widget More...

#include <vtkKWCheckButton.h>

Inheritance diagram for vtkKWCheckButton:

Inheritance graph
[legend]
Collaboration diagram for vtkKWCheckButton:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vtkTypeRevisionMacro (vtkKWCheckButton, vtkKWCoreWidget)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Create (vtkKWApplication *app)
virtual void SetCommand (vtkObject *object, const char *method)
virtual void UpdateEnableState ()
virtual void SetSelectedState (int)
virtual int GetSelectedState ()
virtual void SelectedStateOn ()
virtual void SelectedStateOff ()
virtual void ToggleSelectedState ()
virtual void Select ()
virtual void DeSelect ()
virtual void SetIndicatorVisibility (int ind)
virtual int GetIndicatorVisibility ()
virtual void IndicatorVisibilityOn ()
virtual void IndicatorVisibilityOff ()
virtual void SetText (const char *txt)
virtual const char * GetText ()
virtual char * GetVariableName ()
virtual void SetVariableName (const char *)
virtual void SetAnchor (int)
virtual int GetAnchor ()
virtual void SetAnchorToNorth ()
virtual void SetAnchorToNorthEast ()
virtual void SetAnchorToEast ()
virtual void SetAnchorToSouthEast ()
virtual void SetAnchorToSouth ()
virtual void SetAnchorToSouthWest ()
virtual void SetAnchorToWest ()
virtual void SetAnchorToNorthWest ()
virtual void SetAnchorToCenter ()
virtual void SetOffRelief (int)
virtual int GetOffRelief ()
virtual void SetOffReliefToRaised ()
virtual void SetOffReliefToSunken ()
virtual void SetOffReliefToFlat ()
virtual void SetOffReliefToRidge ()
virtual void SetOffReliefToSolid ()
virtual void SetOffReliefToGroove ()
virtual void SetOverRelief (int)
virtual int GetOverRelief ()
virtual void SetOverReliefToRaised ()
virtual void SetOverReliefToSunken ()
virtual void SetOverReliefToFlat ()
virtual void SetOverReliefToRidge ()
virtual void SetOverReliefToSolid ()
virtual void SetOverReliefToGroove ()
virtual void SetOverReliefToNone ()
virtual void SetImageToIcon (vtkKWIcon *icon)
virtual void SetImageToPredefinedIcon (int icon_index)
virtual void SetImageToPixels (const unsigned char *pixels, int width, int height, int pixel_size, unsigned long buffer_length=0)

Static Public Member Functions

vtkKWCheckButton * New ()

Protected Member Functions

virtual void SetMyText (const char *)
 vtkKWCheckButton ()
 ~vtkKWCheckButton ()
void Configure ()

Protected Attributes

int IndicatorVisibility
char * MyText
char * VariableName

Detailed Description

check button widget

A simple widget that represents a check button. It can be modified and queried using the GetSelectedState and SetSelectedState methods.

Definition at line 28 of file vtkKWCheckButton.h.

Constructor & Destructor Documentation

vtkKWCheckButton::vtkKWCheckButton (   )  [protected]
 

vtkKWCheckButton::~vtkKWCheckButton (   )  [protected]
 

Member Function Documentation

vtkKWCheckButton* vtkKWCheckButton::New (   )  [static]
 

Reimplemented from vtkKWCoreWidget.

Reimplemented in vtkKWRadioButton.

vtkKWCheckButton::vtkTypeRevisionMacro (  vtkKWCheckButton  ,
vtkKWCoreWidget 
) 
 

void vtkKWCheckButton::PrintSelf (  ostream &  os,
vtkIndent  indent
) 
 

Reimplemented from vtkKWCoreWidget.

Reimplemented in vtkKWRadioButton.

virtual void vtkKWCheckButton::Create (  vtkKWApplication *  app  )  [virtual]
 

Create the widget.

Reimplemented from vtkKWCoreWidget.

Reimplemented in vtkKWRadioButton.

virtual void vtkKWCheckButton::SetSelectedState (  int   )  [virtual]
 

Set/Get/Toggle the state of the check button 0 = off 1 = on

virtual int vtkKWCheckButton::GetSelectedState (   )  [virtual]
 

Set/Get/Toggle the state of the check button 0 = off 1 = on

Reimplemented in vtkKWRadioButton.

virtual void vtkKWCheckButton::SelectedStateOn (   )  [virtual]
 

Set/Get/Toggle the state of the check button 0 = off 1 = on

Reimplemented in vtkKWRadioButton.

virtual void vtkKWCheckButton::SelectedStateOff (   )  [virtual]
 

Set/Get/Toggle the state of the check button 0 = off 1 = on

Reimplemented in vtkKWRadioButton.

virtual void vtkKWCheckButton::ToggleSelectedState (   )  [virtual]
 

Set/Get/Toggle the state of the check button 0 = off 1 = on

virtual void vtkKWCheckButton::Select (   )  [inline, virtual]
 

Set/Get/Toggle the state of the check button 0 = off 1 = on

Definition at line 44 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::DeSelect (   )  [inline, virtual]
 

Set/Get/Toggle the state of the check button 0 = off 1 = on

Definition at line 45 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetIndicatorVisibility (  int  ind  )  [virtual]
 

Tell the widget whether it should use an indicator (check box)

virtual int vtkKWCheckButton::GetIndicatorVisibility (   )  [virtual]
 

Tell the widget whether it should use an indicator (check box)

virtual void vtkKWCheckButton::IndicatorVisibilityOn (   )  [virtual]
 

Tell the widget whether it should use an indicator (check box)

virtual void vtkKWCheckButton::IndicatorVisibilityOff (   )  [virtual]
 

Tell the widget whether it should use an indicator (check box)

virtual void vtkKWCheckButton::SetText (  const char *  txt  )  [virtual]
 

Set the text.

virtual const char* vtkKWCheckButton::GetText (   )  [virtual]
 

Set the text.

virtual char* vtkKWCheckButton::GetVariableName (   )  [virtual]
 

Set the variable name.

virtual void vtkKWCheckButton::SetVariableName (  const char *   )  [virtual]
 

Set the variable name.

virtual void vtkKWCheckButton::SetCommand (  vtkObject *  object,
const char *  method
)  [virtual]
 

Specifies a command to associate with the widget. This command is typically invoked when mouse button 1 is released over the button. The first argument is the object that will have the method called on it. The second argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is evaluated as a simple command.

virtual void vtkKWCheckButton::SetAnchor (  int   )  [virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

virtual int vtkKWCheckButton::GetAnchor (   )  [virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

virtual void vtkKWCheckButton::SetAnchorToNorth (   )  [inline, virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

Definition at line 81 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetAnchorToNorthEast (   )  [inline, virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

Definition at line 83 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetAnchorToEast (   )  [inline, virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

Definition at line 85 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetAnchorToSouthEast (   )  [inline, virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

Definition at line 87 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetAnchorToSouth (   )  [inline, virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

Definition at line 89 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetAnchorToSouthWest (   )  [inline, virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

Definition at line 91 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetAnchorToWest (   )  [inline, virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

Definition at line 93 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetAnchorToNorthWest (   )  [inline, virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

Definition at line 95 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetAnchorToCenter (   )  [inline, virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

Definition at line 97 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetOffRelief (  int   )  [virtual]
 

Set/Get the 3-D effect desired for the widget. Specifies the relief for the button when the indicator is not drawn (i.e. IndicatorVisibility is Off) and the button is not selected. The default value is Raised. By setting this option to Flat and setting IndicatorVisibility to Off and OverRelief to Raised or Flat, the effect is achieved of having a flat button that raises on mouse-over and which is depressed when activated. This is the behavior typically exhibited by the Bold, Italic, and Underline checkbuttons on the toolbar of a word-processor, for example. Valid constants can be found in vtkKWTkOptions::ReliefType.

virtual int vtkKWCheckButton::GetOffRelief (   )  [virtual]
 

Set/Get the 3-D effect desired for the widget. Specifies the relief for the button when the indicator is not drawn (i.e. IndicatorVisibility is Off) and the button is not selected. The default value is Raised. By setting this option to Flat and setting IndicatorVisibility to Off and OverRelief to Raised or Flat, the effect is achieved of having a flat button that raises on mouse-over and which is depressed when activated. This is the behavior typically exhibited by the Bold, Italic, and Underline checkbuttons on the toolbar of a word-processor, for example. Valid constants can be found in vtkKWTkOptions::ReliefType.

virtual void vtkKWCheckButton::SetOffReliefToRaised (   )  [inline, virtual]
 

Set/Get the 3-D effect desired for the widget. Specifies the relief for the button when the indicator is not drawn (i.e. IndicatorVisibility is Off) and the button is not selected. The default value is Raised. By setting this option to Flat and setting IndicatorVisibility to Off and OverRelief to Raised or Flat, the effect is achieved of having a flat button that raises on mouse-over and which is depressed when activated. This is the behavior typically exhibited by the Bold, Italic, and Underline checkbuttons on the toolbar of a word-processor, for example. Valid constants can be found in vtkKWTkOptions::ReliefType.

Definition at line 114 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetOffReliefToSunken (   )  [inline, virtual]
 

Set/Get the 3-D effect desired for the widget. Specifies the relief for the button when the indicator is not drawn (i.e. IndicatorVisibility is Off) and the button is not selected. The default value is Raised. By setting this option to Flat and setting IndicatorVisibility to Off and OverRelief to Raised or Flat, the effect is achieved of having a flat button that raises on mouse-over and which is depressed when activated. This is the behavior typically exhibited by the Bold, Italic, and Underline checkbuttons on the toolbar of a word-processor, for example. Valid constants can be found in vtkKWTkOptions::ReliefType.

Definition at line 116 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetOffReliefToFlat (   )  [inline, virtual]
 

Set/Get the 3-D effect desired for the widget. Specifies the relief for the button when the indicator is not drawn (i.e. IndicatorVisibility is Off) and the button is not selected. The default value is Raised. By setting this option to Flat and setting IndicatorVisibility to Off and OverRelief to Raised or Flat, the effect is achieved of having a flat button that raises on mouse-over and which is depressed when activated. This is the behavior typically exhibited by the Bold, Italic, and Underline checkbuttons on the toolbar of a word-processor, for example. Valid constants can be found in vtkKWTkOptions::ReliefType.

Definition at line 118 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetOffReliefToRidge (   )  [inline, virtual]
 

Set/Get the 3-D effect desired for the widget. Specifies the relief for the button when the indicator is not drawn (i.e. IndicatorVisibility is Off) and the button is not selected. The default value is Raised. By setting this option to Flat and setting IndicatorVisibility to Off and OverRelief to Raised or Flat, the effect is achieved of having a flat button that raises on mouse-over and which is depressed when activated. This is the behavior typically exhibited by the Bold, Italic, and Underline checkbuttons on the toolbar of a word-processor, for example. Valid constants can be found in vtkKWTkOptions::ReliefType.

Definition at line 120 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetOffReliefToSolid (   )  [inline, virtual]
 

Set/Get the 3-D effect desired for the widget. Specifies the relief for the button when the indicator is not drawn (i.e. IndicatorVisibility is Off) and the button is not selected. The default value is Raised. By setting this option to Flat and setting IndicatorVisibility to Off and OverRelief to Raised or Flat, the effect is achieved of having a flat button that raises on mouse-over and which is depressed when activated. This is the behavior typically exhibited by the Bold, Italic, and Underline checkbuttons on the toolbar of a word-processor, for example. Valid constants can be found in vtkKWTkOptions::ReliefType.

Definition at line 122 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetOffReliefToGroove (   )  [inline, virtual]
 

Set/Get the 3-D effect desired for the widget. Specifies the relief for the button when the indicator is not drawn (i.e. IndicatorVisibility is Off) and the button is not selected. The default value is Raised. By setting this option to Flat and setting IndicatorVisibility to Off and OverRelief to Raised or Flat, the effect is achieved of having a flat button that raises on mouse-over and which is depressed when activated. This is the behavior typically exhibited by the Bold, Italic, and Underline checkbuttons on the toolbar of a word-processor, for example. Valid constants can be found in vtkKWTkOptions::ReliefType.

Definition at line 124 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetOverRelief (  int   )  [virtual]
 

Set/Get the 3-D effect desired for the widget. Specifies an alternative relief for the button, to be used when the mouse cursor is over the widget. This option can be used to make toolbar buttons, by configuring SetRelief to Flat and OverRelief to Raised. Valid constants can be found in vtkKWTkOptions::ReliefType. If the value of this option is None, then no alternative relief is used when the mouse cursor is over the checkbutton.

virtual int vtkKWCheckButton::GetOverRelief (   )  [virtual]
 

Set/Get the 3-D effect desired for the widget. Specifies an alternative relief for the button, to be used when the mouse cursor is over the widget. This option can be used to make toolbar buttons, by configuring SetRelief to Flat and OverRelief to Raised. Valid constants can be found in vtkKWTkOptions::ReliefType. If the value of this option is None, then no alternative relief is used when the mouse cursor is over the checkbutton.

virtual void vtkKWCheckButton::SetOverReliefToRaised (   )  [inline, virtual]
 

Set/Get the 3-D effect desired for the widget. Specifies an alternative relief for the button, to be used when the mouse cursor is over the widget. This option can be used to make toolbar buttons, by configuring SetRelief to Flat and OverRelief to Raised. Valid constants can be found in vtkKWTkOptions::ReliefType. If the value of this option is None, then no alternative relief is used when the mouse cursor is over the checkbutton.

Definition at line 138 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetOverReliefToSunken (   )  [inline, virtual]
 

Set/Get the 3-D effect desired for the widget. Specifies an alternative relief for the button, to be used when the mouse cursor is over the widget. This option can be used to make toolbar buttons, by configuring SetRelief to Flat and OverRelief to Raised. Valid constants can be found in vtkKWTkOptions::ReliefType. If the value of this option is None, then no alternative relief is used when the mouse cursor is over the checkbutton.

Definition at line 140 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetOverReliefToFlat (   )  [inline, virtual]
 

Set/Get the 3-D effect desired for the widget. Specifies an alternative relief for the button, to be used when the mouse cursor is over the widget. This option can be used to make toolbar buttons, by configuring SetRelief to Flat and OverRelief to Raised. Valid constants can be found in vtkKWTkOptions::ReliefType. If the value of this option is None, then no alternative relief is used when the mouse cursor is over the checkbutton.

Definition at line 142 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetOverReliefToRidge (   )  [inline, virtual]
 

Set/Get the 3-D effect desired for the widget. Specifies an alternative relief for the button, to be used when the mouse cursor is over the widget. This option can be used to make toolbar buttons, by configuring SetRelief to Flat and OverRelief to Raised. Valid constants can be found in vtkKWTkOptions::ReliefType. If the value of this option is None, then no alternative relief is used when the mouse cursor is over the checkbutton.

Definition at line 144 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetOverReliefToSolid (   )  [inline, virtual]
 

Set/Get the 3-D effect desired for the widget. Specifies an alternative relief for the button, to be used when the mouse cursor is over the widget. This option can be used to make toolbar buttons, by configuring SetRelief to Flat and OverRelief to Raised. Valid constants can be found in vtkKWTkOptions::ReliefType. If the value of this option is None, then no alternative relief is used when the mouse cursor is over the checkbutton.

Definition at line 146 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetOverReliefToGroove (   )  [inline, virtual]
 

Set/Get the 3-D effect desired for the widget. Specifies an alternative relief for the button, to be used when the mouse cursor is over the widget. This option can be used to make toolbar buttons, by configuring SetRelief to Flat and OverRelief to Raised. Valid constants can be found in vtkKWTkOptions::ReliefType. If the value of this option is None, then no alternative relief is used when the mouse cursor is over the checkbutton.

Definition at line 148 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetOverReliefToNone (   )  [inline, virtual]
 

Set/Get the 3-D effect desired for the widget. Specifies an alternative relief for the button, to be used when the mouse cursor is over the widget. This option can be used to make toolbar buttons, by configuring SetRelief to Flat and OverRelief to Raised. Valid constants can be found in vtkKWTkOptions::ReliefType. If the value of this option is None, then no alternative relief is used when the mouse cursor is over the checkbutton.

Definition at line 150 of file vtkKWCheckButton.h.

virtual void vtkKWCheckButton::SetImageToIcon (  vtkKWIcon *  icon  )  [virtual]
 

Specifies an image to display in the widget. Typically, if the image is specified then it overrides other options that specify a bitmap or textual value to display in the widget. Invoke vtkKWWidget's SetConfigurationOption("-image", imagename) to use a specific pre-existing Tk image, or call one of the following functions. The SetImageToPredefinedIcon method accepts an index to one of the predefined icon listed in vtkKWIcon. The SetImageToPixels method sets the image using pixel data. It expects a pointer to the pixels and the structure of the image, i.e. its width, height and the pixel_size (how many bytes per pixel, say 3 for RGB, or 1 for grayscale). If buffer_length = 0, it is computed automatically from the previous parameters. If it is not, it will most likely indicate that the buffer has been encoded using base64 and/or zlib. If pixel_size > 3 (i.e. RGBA), the image is blend the with background color of the widget.

virtual void vtkKWCheckButton::SetImageToPredefinedIcon (  int  icon_index  )  [virtual]
 

Specifies an image to display in the widget. Typically, if the image is specified then it overrides other options that specify a bitmap or textual value to display in the widget. Invoke vtkKWWidget's SetConfigurationOption("-image", imagename) to use a specific pre-existing Tk image, or call one of the following functions. The SetImageToPredefinedIcon method accepts an index to one of the predefined icon listed in vtkKWIcon. The SetImageToPixels method sets the image using pixel data. It expects a pointer to the pixels and the structure of the image, i.e. its width, height and the pixel_size (how many bytes per pixel, say 3 for RGB, or 1 for grayscale). If buffer_length = 0, it is computed automatically from the previous parameters. If it is not, it will most likely indicate that the buffer has been encoded using base64 and/or zlib. If pixel_size > 3 (i.e. RGBA), the image is blend the with background color of the widget.

virtual void vtkKWCheckButton::SetImageToPixels (  const unsigned char *  pixels,
int  width,
int  height,
int  pixel_size,
unsigned long  buffer_length = 0
)  [virtual]
 

Specifies an image to display in the widget. Typically, if the image is specified then it overrides other options that specify a bitmap or textual value to display in the widget. Invoke vtkKWWidget's SetConfigurationOption("-image", imagename) to use a specific pre-existing Tk image, or call one of the following functions. The SetImageToPredefinedIcon method accepts an index to one of the predefined icon listed in vtkKWIcon. The SetImageToPixels method sets the image using pixel data. It expects a pointer to the pixels and the structure of the image, i.e. its width, height and the pixel_size (how many bytes per pixel, say 3 for RGB, or 1 for grayscale). If buffer_length = 0, it is computed automatically from the previous parameters. If it is not, it will most likely indicate that the buffer has been encoded using base64 and/or zlib. If pixel_size > 3 (i.e. RGBA), the image is blend the with background color of the widget.

virtual void vtkKWCheckButton::UpdateEnableState (   )  [virtual]
 

Update the "enable" state of the object and its internal parts. Depending on different Ivars (this->Enabled, the application's Limited Edition Mode, etc.), the "enable" state of the object is updated and propagated to its internal parts/subwidgets. This will, for example, enable/disable parts of the widget UI, enable/disable the visibility of 3D widgets, etc.

Reimplemented from vtkKWWidget.

virtual void vtkKWCheckButton::SetMyText (  const char *   )  [protected, virtual]
 

void vtkKWCheckButton::Configure (   )  [protected]
 

Member Data Documentation

int vtkKWCheckButton::IndicatorVisibility [protected]
 

Definition at line 192 of file vtkKWCheckButton.h.

char* vtkKWCheckButton::MyText [protected]
 

Definition at line 193 of file vtkKWCheckButton.h.

char* vtkKWCheckButton::VariableName [protected]
 

Definition at line 194 of file vtkKWCheckButton.h.

The documentation for this class was generated from the following file:
Generated on Tue May 30 12:36:13 2006 for ParaView by doxygen 1.3.5