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

vtkKWPushButton Class Reference

push button widget More...

#include <vtkKWPushButton.h>

Inheritance diagram for vtkKWPushButton:

Inheritance graph
[legend]
Collaboration diagram for vtkKWPushButton:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vtkTypeRevisionMacro (vtkKWPushButton, 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 SetText (const char *label)
virtual char * GetText ()
virtual void SetWidth (int width)
virtual int GetWidth ()
virtual void SetHeight (int height)
virtual int GetHeight ()
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 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

vtkKWPushButton * New ()

Protected Member Functions

 vtkKWPushButton ()
 ~vtkKWPushButton ()
virtual void SetButtonText (const char *)

Protected Attributes

char * ButtonText

Detailed Description

push button widget

A simple widget that represents a push button.

Definition at line 27 of file vtkKWPushButton.h.

Constructor & Destructor Documentation

vtkKWPushButton::vtkKWPushButton (   )  [protected]
 

vtkKWPushButton::~vtkKWPushButton (   )  [protected]
 

Member Function Documentation

vtkKWPushButton* vtkKWPushButton::New (   )  [static]
 

Reimplemented from vtkKWCoreWidget.

Reimplemented in vtkKWLoadSaveButton, vtkKWPopupButton, and vtkKWPushButtonWithMenu.

vtkKWPushButton::vtkTypeRevisionMacro (  vtkKWPushButton  ,
vtkKWCoreWidget 
) 
 

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

Reimplemented from vtkKWCoreWidget.

Reimplemented in vtkKWLoadSaveButton, vtkKWPopupButton, and vtkKWPushButtonWithMenu.

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

Create the widget.

Reimplemented from vtkKWCoreWidget.

Reimplemented in vtkKWLoadSaveButton, vtkKWPopupButton, and vtkKWPushButtonWithMenu.

virtual void vtkKWPushButton::SetText (  const char *  label  )  [virtual]
 

Convenience method to set the contents label.

virtual char* vtkKWPushButton::GetText (   )  [virtual]
 

Convenience method to set the contents label.

virtual void vtkKWPushButton::SetWidth (  int  width  )  [virtual]
 

Convenience method to set/get the text width (in chars if the button has a text contents, or pixels if it has an image contents).

virtual int vtkKWPushButton::GetWidth (   )  [virtual]
 

Convenience method to set/get the text width (in chars if the button has a text contents, or pixels if it has an image contents).

virtual void vtkKWPushButton::SetHeight (  int  height  )  [virtual]
 

Convenience method to set/get the text height (in chars if the button has a text contents, or pixels if it has an image contents).

virtual int vtkKWPushButton::GetHeight (   )  [virtual]
 

Convenience method to set/get the text height (in chars if the button has a text contents, or pixels if it has an image contents).

virtual void vtkKWPushButton::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.

Reimplemented in vtkKWLoadSaveButton.

virtual void vtkKWPushButton::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 vtkKWPushButton::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 vtkKWPushButton::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 71 of file vtkKWPushButton.h.

virtual void vtkKWPushButton::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 73 of file vtkKWPushButton.h.

virtual void vtkKWPushButton::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 75 of file vtkKWPushButton.h.

virtual void vtkKWPushButton::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 77 of file vtkKWPushButton.h.

virtual void vtkKWPushButton::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 79 of file vtkKWPushButton.h.

virtual void vtkKWPushButton::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 81 of file vtkKWPushButton.h.

virtual void vtkKWPushButton::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 83 of file vtkKWPushButton.h.

virtual void vtkKWPushButton::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 85 of file vtkKWPushButton.h.

virtual void vtkKWPushButton::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 87 of file vtkKWPushButton.h.

virtual void vtkKWPushButton::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 vtkKWPushButton::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 vtkKWPushButton::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 101 of file vtkKWPushButton.h.

virtual void vtkKWPushButton::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 103 of file vtkKWPushButton.h.

virtual void vtkKWPushButton::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 105 of file vtkKWPushButton.h.

virtual void vtkKWPushButton::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 107 of file vtkKWPushButton.h.

virtual void vtkKWPushButton::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 109 of file vtkKWPushButton.h.

virtual void vtkKWPushButton::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 111 of file vtkKWPushButton.h.

virtual void vtkKWPushButton::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 113 of file vtkKWPushButton.h.

virtual void vtkKWPushButton::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 vtkKWPushButton::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 vtkKWPushButton::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 vtkKWPushButton::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.

Reimplemented in vtkKWLoadSaveButton, vtkKWPopupButton, and vtkKWPushButtonWithMenu.

virtual void vtkKWPushButton::SetButtonText (  const char *   )  [protected, virtual]
 

Member Data Documentation

char* vtkKWPushButton::ButtonText [protected]
 

Definition at line 153 of file vtkKWPushButton.h.

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