rnr::WinButton Class Reference

Window button base class. More...

#include <WinMenu.h>

Inheritance diagram for rnr::WinButton:

Public Member Functions
	WinButton (WinButtonType eType, int nEvent, WidgetState eInitState, AlignOp eAlign, const std::string &strAltText, const std::string &strTagNormal, const std::string &strToolTipNormal="", const std::string &strTagActive="", const std::string &strToolTipActive="")
	WinButton initialization constructor. More...
	WinButton (const WinButton &src)
	WinButton copy constructor. More...
virtual	~WinButton ()
	Destructor.
virtual void *	getNormalImageWidget ()
	Get the normal icon image widget. More...
virtual void *	getActiveImageWidget ()
	Get the active icon image widget. More...
void *	getCurrentImageWidget ()
	Get the icon image widget associated with the current button state. More...
std::string	getCurrentLabel ()
	Get the text label associated with the current button state. More...
std::string	getCurrentToolTip ()
	Get the tooltip associated with the current button state. More...

Protected Member Functions
void	copy (const WinButton *pSrc)
	Deep copy of source to this. More...

Protected Attributes
WinButtonType	m_eType
	button type
int	m_nEvent
	button push "mouse click" event
WidgetState	m_eInitState
	initial button widget state
WidgetState	m_eState
	current button widget state
AlignOp	m_eAlign
	left or right alignment
std::string	m_strAltText
	alternate text for icon(s)
std::string	m_strTagNormal
	button icon for normal state
std::string	m_strToolTipNormal
	button tooltip for normal state
std::string	m_strTagActive
	button icon for active state
std::string	m_strToolTipActive
	button tooltip for active state

Friends
class	WinButtonMenu

Detailed Description

Window button base class.

Definition at line 94 of file WinMenu.h.

Constructor & Destructor Documentation

rnr::WinButton::WinButton ( WinButtonType  eType, int  nEvent, WidgetState  eInitState, AlignOp  eAlign, const std::string &  strAltText, const std::string &  strTagNormal, const std::string &  strToolTipNormal = "", const std::string &  strTagActive = "", const std::string &  strToolTipActive = ""  )

inline

WinButton initialization constructor.

Parameters

eType	Button type.
nEvent	Event associated with button press (and id).
eInitState	Button widget initial state. See GUI Widget State.
eAlign	Button alignment. See rnmpwin_align.
strAltText	Button alternative text string.
strTagNormal	Button visual tag for normal state. Either icon path or text string label.
strToolTipNormal	Button tooltip for normal state.
strTagActive	Button visual tag for active state. Either icon path or text string label. Empty for no tag.
strToolTipActive	Button tooltip for active state.

Definition at line 115 of file WinMenu.h.

                                                       :
        m_eType(eType),
        m_nEvent(nEvent),
        m_eInitState(eInitState),
        m_eState(eInitState),
        m_eAlign(eAlign),
        m_strAltText(strAltText),
        m_strTagNormal(strTagNormal),
        m_strToolTipNormal(strToolTipNormal),
        m_strTagActive(strTagActive),
        m_strToolTipActive(strToolTipActive)
    {
    }

rnr::WinButton::WinButton ( const WinButton &  src )

inline

WinButton copy constructor.

Parameters

src	Source window button.

Definition at line 142 of file WinMenu.h.

References copy().

    {
      copy(&src);
    }

Member Function Documentation

void WinButton::copy ( const WinButton *  pSrc )

protected

Deep copy of source to this.

Parameters

pSrc	Pointer to source button.

Definition at line 80 of file WinMenu.cxx.

References m_eAlign, m_eInitState, m_eType, m_nEvent, m_strAltText, m_strTagActive, m_strTagNormal, m_strToolTipActive, and m_strToolTipNormal.

Referenced by WinButton().

{
  m_eType             = pSrc->m_eType;
  m_nEvent            = pSrc->m_nEvent;
  m_eInitState        = pSrc->m_eInitState;
  m_eState            = pSrc->m_eInitState;
  m_eAlign            = pSrc->m_eAlign;
  m_strAltText        = pSrc->m_strAltText;
  m_strTagNormal      = pSrc->m_strTagNormal;
  m_strToolTipNormal  = pSrc->m_strToolTipNormal;
  m_strTagActive      = pSrc->m_strTagActive;
  m_strToolTipActive  = pSrc->m_strToolTipActive;
}

virtual void* rnr::WinButton::getActiveImageWidget ( )

inlinevirtual

Get the active icon image widget.

Returns

Returns (possibly NULL) pointer to image widget (gui toolkit specific).

Reimplemented in rnr::WinGtkButton.

Definition at line 169 of file WinMenu.h.

References getCurrentImageWidget(), getCurrentLabel(), and getCurrentToolTip().

Referenced by rnr::WinButtonMenu::changeButtonState().

    {
      return NULL;
    }

void * WinButton::getCurrentImageWidget

(

)

Get the icon image widget associated with the current button state.

Returns

Returns pointer to image widget (gui toolkit specific) if found.
Otherwise returns NULL.

Definition at line 94 of file WinMenu.cxx.

References rnr::WidgetStateActive, and rnr::WinButtonTypeImage.

Referenced by rnr::WinButtonMenu::bind(), and getActiveImageWidget().

{
  if( m_eType != WinButtonTypeImage )
  {
    return NULL;
  }
  else if( (m_eState == WidgetStateActive) && (getActiveImageWidget() != NULL) )
  {
    return getActiveImageWidget();
  }
  else
  {
    return getNormalImageWidget();
  }
} 

string WinButton::getCurrentLabel

(

)

Get the text label associated with the current button state.

Returns

Returns (possibly empty) text string.

Definition at line 110 of file WinMenu.cxx.

References rnr::WidgetStateActive, and rnr::WinButtonTypeLabel.

Referenced by rnr::WinButtonMenu::bind(), and getActiveImageWidget().

{
  if( m_eType != WinButtonTypeLabel )
  {
    return "";
  }
  else if( (m_eState == WidgetStateActive) && !m_strTagActive.empty() )
  {
    return m_strTagActive;
  }
  else
  {
    return m_strTagNormal;
  }
}

string WinButton::getCurrentToolTip

(

)

Get the tooltip associated with the current button state.

Returns

Returns (possibly empty) text string.

Definition at line 126 of file WinMenu.cxx.

References rnr::WidgetStateActive, rnr::WinButtonTypeImage, and rnr::WinButtonTypeLabel.

Referenced by rnr::WinButtonMenu::bind(), and getActiveImageWidget().

{
  if( m_eState == WidgetStateActive )
  {
    switch( m_eType )
    {
      case WinButtonTypeImage:
        if( getActiveImageWidget() != NULL )
        {
          return m_strToolTipActive;
        }
        break;
      case WinButtonTypeLabel:
        if( !m_strTagActive.empty() )
        {
          return m_strToolTipActive;
        }
        break;
      default:
        break;
    }
  }
  return m_strToolTipNormal;
}

virtual void* rnr::WinButton::getNormalImageWidget ( )

inlinevirtual

Get the normal icon image widget.

Returns

Returns (possibly NULL) pointer to image widget (gui toolkit specific).

Reimplemented in rnr::WinGtkButton.

Definition at line 158 of file WinMenu.h.

Referenced by rnr::WinButtonMenu::changeButtonState().

    {
      return NULL;
    }

---

The documentation for this class was generated from the following files:

• include/rnr/appkit/WinMenu.h
• sw/librnr_win/WinMenu.cxx