rnr::WinGtkButton Class Reference

GTK window derived button class. More...

#include <WinGtkMenu.h>

Inheritance diagram for rnr::WinGtkButton:

Public Member Functions
	WinGtkButton (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="")
	WinGtkButton initialization constructor. More...
	WinGtkButton (const WinGtkButton &src)
	WinGtkButton copy constructor. More...
virtual	~WinGtkButton ()
	Destructor.
virtual void *	getNormalImageWidget ()
	Get the normal icon image widget. More...
virtual void *	getActiveImageWidget ()
	Get the active icon image widget. More...
Public Member Functions inherited from 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="")
	WinButton initialization constructor. More...
	WinButton (const WinButton &src)
	WinButton copy constructor. More...
virtual	~WinButton ()
	Destructor.
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
GtkWidget *	loadIcon (const std::string &strIconPath)
	Load icon image from file. More...
Protected Member Functions inherited from rnr::WinButton
void	copy (const WinButton *pSrc)
	Deep copy of source to this. More...

Protected Attributes
GtkWidget *	m_wImgNormal
	normal state menu button icon
GtkWidget *	m_wImgActive
	active state menu button icon
Protected Attributes inherited from rnr::WinButton
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	WinGtkButtonMenu

Detailed Description

GTK window derived button class.

Definition at line 82 of file WinGtkMenu.h.

Constructor & Destructor Documentation

rnr::WinGtkButton::WinGtkButton	(	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 = ""
	)

WinGtkButton 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.

Referenced by rnr::WinGtkButtonMenu::addImageButton(), and rnr::WinGtkButtonMenu::addLabelButton().

WinGtkButton::WinGtkButton

(

const WinGtkButton &

src

)

WinGtkButton copy constructor.

Parameters

src	Source button item.

Definition at line 105 of file WinGtkMenu.cxx.

References loadIcon(), rnr::WinButton::m_eType, rnr::WinButton::m_strTagActive, rnr::WinButton::m_strTagNormal, m_wImgActive, m_wImgNormal, and rnr::WinButtonTypeImage.

                                                  : WinButton(src)
{
  if( m_eType == WinButtonTypeImage )
  {
    m_wImgNormal = loadIcon(m_strTagNormal);
    m_wImgActive = loadIcon(m_strTagActive);
  }
  else
  {
    m_wImgNormal = NULL;
    m_wImgActive = NULL;
  }
}

Member Function Documentation

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

inlinevirtual

Get the active icon image widget.

Returns

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

Reimplemented from rnr::WinButton.

Definition at line 142 of file WinGtkMenu.h.

References m_wImgActive.

    {
      return m_wImgActive;
    }

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

inlinevirtual

Get the normal icon image widget.

Returns

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

Reimplemented from rnr::WinButton.

Definition at line 131 of file WinGtkMenu.h.

References m_wImgNormal.

    {
      return m_wImgNormal;
    }

GtkWidget * WinGtkButton::loadIcon ( const std::string &  strIconPath )

protected

Load icon image from file.

Note

For best visualization, the icons should be 48x48 pixels.

Parameters

strIconPath

Icon file path.

Returns

Returns pointer to GtkImage widget if icon successfully loaded, else returns NULL.

Definition at line 132 of file WinGtkMenu.cxx.

Referenced by WinGtkButton().

{
  GtkWidget  *wBttnImg;

  if( access(strIconPath.c_str(), F_OK|R_OK) != 0 )
  {
    LOGSYSERROR("%s: %s(errno=%d)", strIconPath.c_str());
    return NULL;
  }

  // never returns null - will return "broken" icon instead
  wBttnImg = gtk_image_new_from_file(strIconPath.c_str());

  // menu item owns this widget
  gtk_widget_ref(wBttnImg);

  return wBttnImg;
}

---

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

• include/rnr/appkit/WinGtkMenu.h
• sw/librnr_wingtk/WinGtkMenu.cxx