ui::AbstractButton Class Reference

Inheritance diagram for ui::AbstractButton:

Inheritance graph
[legend]
Collaboration diagram for ui::AbstractButton:

Collaboration graph
[legend]
List of all members.

Detailed Description

Abstract Button class. This is an abstract base class for all button related Components (Buttons,MenuItem).


Public Types

enum  PROPERTYCHANGES { FOCUSPAINTCHANGED = 1, SELECTIONCHANGE = 2, TEXTCHANGE = 3 }

Public Member Functions

bool isFocusPainted () const
void setFocusPainted (bool enable)
void setContentAreaFilled (bool b)
bool isContentAreaFilled () const
void setMargin (const util::Insets &m)
const util::InsetsgetMargin () const
void setText (const std::string &value)
const std::string & getText () const
void setHorizontalAlignment (int alignment)
void setVerticalAlignment (int alignment)
int getHorizontalAlignment () const
int getVerticalAlignment () const
void setSelected (bool value)
bool isSelected () const
void setDefaultIcon (Icon *icon)
void setSelectedIcon (Icon *icon)
void setDisabledDefaultIcon (Icon *icon)
void setDisabledSelectedIcon (Icon *icon)
IcongetDefaultIcon () const
IcongetDisabledDefaultIcon () const
IcongetSelectedIcon () const
IcongetDisabledSelectedIcon () const
void doPressed ()
void doReleased ()
void doClicked ()


Member Function Documentation

bool ui::AbstractButton::isFocusPainted  )  const
 

Returns true if the focus is painted, false otherwise.

void ui::AbstractButton::setFocusPainted bool  enable  ) 
 

Enable or disable focus painting by setting this flag.

void ui::AbstractButton::setContentAreaFilled bool  b  ) 
 

Sets the flag for painting the content area, that is the background color.

bool ui::AbstractButton::isContentAreaFilled  )  const
 

Returns wether the content area should be painted.

void ui::AbstractButton::setMargin const util::Insets m  ) 
 

Returns the margin used for laying out the text.

const util::Insets & ui::AbstractButton::getMargin  )  const
 

Sets the margin used for laying out the text.

void ui::AbstractButton::setText const std::string &  value  ) 
 

Sets the label on the Component.

Parameters:
value label to be set on the Component

const std::string & ui::AbstractButton::getText  )  const
 

Returns the current label for this Component

Returns:
the label.

void ui::AbstractButton::setHorizontalAlignment int  alignment  ) 
 

Sets the horizontal alignment of the text.

Parameters:
alignment See Component globals, can be CENTER, LEFT, RIGHT.

void ui::AbstractButton::setVerticalAlignment int  alignment  ) 
 

Sets the vertical alignment of the text.

Parameters:
alignment See Component globals, can be CENTER, LEFT, RIGHT.

int ui::AbstractButton::getHorizontalAlignment  )  const
 

Returns the horizontal alignment.

int ui::AbstractButton::getVerticalAlignment  )  const
 

Returns the vertical alignment.

void ui::AbstractButton::setSelected bool  value  ) 
 

Set the Button to its selected state.

bool ui::AbstractButton::isSelected  )  const
 

Returns the selected state of this Button.

void ui::AbstractButton::setDefaultIcon Icon icon  ) 
 

Sets the default Icon.

void ui::AbstractButton::setSelectedIcon Icon icon  ) 
 

Sets the selected state Icon.

void ui::AbstractButton::setDisabledDefaultIcon Icon icon  ) 
 

Sets the disabled default icon for this Button.

void ui::AbstractButton::setDisabledSelectedIcon Icon icon  ) 
 

Sets the disabled selected icon for this Button.

Icon * ui::AbstractButton::getDefaultIcon  )  const
 

Returns the default icon.

Icon * ui::AbstractButton::getDisabledDefaultIcon  )  const
 

Returns the disabled default icon.

Icon * ui::AbstractButton::getSelectedIcon  )  const
 

Returns the selected icon.

Icon * ui::AbstractButton::getDisabledSelectedIcon  )  const
 

Returns the default selected icon.

void ui::AbstractButton::doPressed  ) 
 

Programmatic click.

void ui::AbstractButton::doReleased  ) 
 

Programmatic click.

void ui::AbstractButton::doClicked  ) 
 

Programmatic click.


Generated on Mon Jun 20 19:41:47 2005 for UI by doxygen 1.3.1 using KingsTools