- Your Widget Set For OpenGL
Main Page | Namespace List | Class Hierarchy | Class List | File List | Class Members | Related Pages

ufo::UCompound Class Reference

This class represents a compound widget with a static text and an icon. More...

#include <ucompound.hpp>

Inheritance diagram for ufo::UCompound:

ufo::UWidget ufo::UObject ufo::UCollectable ufo::UButton ufo::ULabel ufo::UCheckBox ufo::UMenuItem ufo::URadioButton ufo::UCheckBoxMenuItem ufo::UMenu List of all members.

Public Member Functions

 UCompound (const std::string &text)
 UCompound (UIcon *icon)
 UCompound (const std::string &text, UIcon *icon)
virtual void setText (const std::string &text)
std::string getText () const
void setIcon (UIcon *icon)
UIcon * getDefaultIcon () const
virtual UIcon * getIcon () const
void setDisabledIcon (UIcon *icon)
UIcon * getDisabledIcon () const
void setIconTextGap (int iconTextGap)
int getIconTextGap () const

Protected Member Functions

virtual std::ostream & paramString (std::ostream &os) const
virtual void processStateChangeEvent (uint32_t state)
virtual void processStyleHintChange (uint32_t styleHint)
UCompoundModel * getCompoundModel () const
void updateMnemonic ()

Detailed Description

This class represents a compound widget with a static text and an icon.

It is not meant to be used directly. Use instead ULabel, UButton, ...

Author:
Johannes Schmidt


Member Function Documentation

UIcon* ufo::UCompound::getDefaultIcon (   )  const
 

Returns:
The icon which was set with setIcon
See also:
setIcon

UIcon * ufo::UCompound::getDisabledIcon (   )  const [inline]
 

returns the icon that is currently used to paint this button. may be NULL

virtual UIcon* ufo::UCompound::getIcon (   )  const [virtual]
 

returns the icon that is currently used to paint this button.

Returns:
The icon which would be used to paint this icon at the moment

Reimplemented in ufo::UButton.

int ufo::UCompound::getIconTextGap (   )  const [inline]
 

Returns the gap between the text and the icon

std::string ufo::UCompound::getText (   )  const
 

gets the visible text

See also:
setText
Returns:
the static text visible on screen

virtual std::ostream& ufo::UCompound::paramString (  std::ostream &  os  )  const [protected, virtual]
 

Prints some useful internal data to the ostream os. This method is meant only for debugging purposes.

Reimplemented from ufo::UWidget.

Reimplemented in ufo::UMenu.

void ufo::UCompound::setDisabledIcon (  UIcon *  icon  ) 
 

void ufo::UCompound::setIcon (  UIcon *  icon  ) 
 

Sets the default icon for painting.

void ufo::UCompound::setIconTextGap (  int  iconTextGap  ) 
 

Sets the gap between the text and the icon

virtual void ufo::UCompound::setText (  const std::string &  text  )  [virtual]
 

sets the visible text

See also:
getText
Parameters:
text the static which should be visible on screen

Reimplemented in ufo::UButton.


The documentation for this class was generated from the following file:
The libUFO Project - written by Johannes Schmidt