rnr::WinButtonMenu Class Reference

Window button menu base class. More...

#include <WinMenu.h>

Inheritance diagram for rnr::WinButtonMenu:

Public Types
typedef std::map< int, WinButton * >	MapBttns_T
	map of added menu buttons

Public Member Functions
	WinButtonMenu (const std::string &strIconPath=WinIconDirDft)
	WinButtonMenu initialization constructor. More...
virtual	~WinButtonMenu ()
	WinButtonMenu destructor.
void	appendIconDir (const std::string &strIconDir)
	Append directory to icon search path. More...
void	prependIconDir (const std::string &strIconDir)
	Prepend directory to icon search path. More...
void	setIconPath (const std::string &strIconPath)
	Set icon search path. More...
std::string	getIconPath ()
	Get icon search path. More...
virtual bool	addImageButton (int nEvent, WidgetState eInitState, AlignOp eAlign, const std::string &strAltText, const std::string &strIconNormal, const std::string &strToolTipNormal="", const std::string &strIconActive="", const std::string &strToolTipActive="")
	Add button with image to menu. More...
virtual bool	addLabelButton (int nEvent, WidgetState eInitState, AlignOp eAlign, const std::string &strLabelNormal, const std::string &strToolTipNormal="", const std::string &strLabelActive="", const std::string &strToolTipActive="")
	Add button with text label to menu. More...
virtual void	bind (Win *pWin)
	Bind the button menu to the given window. More...
virtual void	unbind ()
	Unbind the menu from the currently bound window.
int	getCurrentEvent ()
	Get the current button menu event. More...
int	setCurrentEvent (int nNewEvent)
	Set the current button menu event. More...
int	getPreviousEvent ()
	Get the previous menu event. More...
size_t	getNumMenuButtons ()
	Get the current number of menu items;. More...
WidgetState	getButtonState (int nEvent)
	Get the given button state. More...
void	setButtonState (int nEvent, WidgetState eNewState)
	Set the given button state. More...
void	setButtonStateList (const std::string &strEvent,...)
	Set the states of the given buttons. More...
void	resetAllButtonStates ()
	Reset all menu buttons states to their initial states.

Protected Member Functions
std::string	makeIconPath (const std::string &strIconFile)
	Make icon image file path. More...
void	changeButtonState (WinButton *pButton, WidgetState eNewState)
	Change the state and gui look of the given button. More...

Static Protected Member Functions
static void	onMenuButtonClick (int nEvent, void *user_data)
	Menu button press callback. More...

Protected Attributes
Win *	m_pWin
	menus are bound to this window
std::string	m_strIconPath
	icon directories search path
int	m_nCurrentEvent
	current (user) menu event
int	m_nPreviousEvent
	previous (user) menu event
MapBttns_T	m_mapButtons
	menu button map

Detailed Description

Window button menu base class.

Buttons with icons or text are placed on the left or right side of the application window. Each icon is associated with an application defined event.

Definition at line 232 of file WinMenu.h.

Constructor & Destructor Documentation

rnr::WinButtonMenu::WinButtonMenu ( const std::string &  strIconPath = WinIconDirDft )

inline

WinButtonMenu initialization constructor.

Parameters

strIconPath

Icon path of search directories.

Definition at line 243 of file WinMenu.h.

References rnr::UIEventNone.

    {
      m_pWin            = NULL;
      m_strIconPath     = strIconPath;
      m_nCurrentEvent   = UIEventNone;
      m_nPreviousEvent  = UIEventNone;
    }

Member Function Documentation

virtual bool rnr::WinButtonMenu::addImageButton ( int  nEvent, WidgetState  eInitState, AlignOp  eAlign, const std::string &  strAltText, const std::string &  strIconNormal, const std::string &  strToolTipNormal = "", const std::string &  strIconActive = "", const std::string &  strToolTipActive = ""  )

inlinevirtual

Add button with image to menu.

Note

Buttons are added to window only at bind() time.

Parameters

nEvent	Unique event (and id) associated with button press.
eInitState	Button widget initial state. See GUI Widget State.
eAlign	Button alignment. See rnmpwin_align.
strAltText	Button alternative text string.
strIconNormal	Button icon image file name for normal state.
strToolTipNormal	Button tooltip for normal state.
strIconActive	Button icon image file name for active state. Empty for no icon.
strToolTipActive	Button tooltip for active state.

Returns

Returns true on success, false otherwise.

Reimplemented in rnr::WinGtkButtonMenu.

Definition at line 329 of file WinMenu.h.

    {
      return false;
    }

virtual bool rnr::WinButtonMenu::addLabelButton ( int  nEvent, WidgetState  eInitState, AlignOp  eAlign, const std::string &  strLabelNormal, const std::string &  strToolTipNormal = "", const std::string &  strLabelActive = "", const std::string &  strToolTipActive = ""  )

inlinevirtual

Add button with text label to menu.

Note

Buttons are added to window only at bind() time.

Parameters

nEvent	Unique event (and id) associated with button press.
eInitState	Button widget initial state. See GUI Widget State.
eAlign	Button alignment. See rnmpwin_align.
strLabelNormal	Button text label for normal state.
strToolTipNormal	Button tooltip for normal state.
strLabelActive	Button text label for active state. Empty for no label.
strToolTipActive	Button tooltip for active state.

Returns

Returns true on success, false otherwise.

Reimplemented in rnr::WinGtkButtonMenu.

Definition at line 359 of file WinMenu.h.

    {
      return false;
    }

void rnr::WinButtonMenu::appendIconDir ( const std::string &  strIconDir )

inline

Append directory to icon search path.

Parameters

strIconDir

Directory holding icons.

Definition at line 261 of file WinMenu.h.

    {
      if( m_strIconPath.empty() )
      {
        m_strIconPath = strIconDir;
      }
      else
      {
        m_strIconPath = m_strIconPath + PATH_SEP_STR + strIconDir;
      }
    }

void WinButtonMenu::bind ( Win *  pWin )

virtual

Bind the button menu to the given window.

Any previously bound menu is unbound. This menu is reset to its initial state. The menu buttons are added to the window and displayed.

Parameters

pWin	Pointer to binding window.

Definition at line 167 of file WinMenu.cxx.

References rnr::WinButton::getCurrentImageWidget(), rnr::WinButton::getCurrentLabel(), rnr::WinButton::getCurrentToolTip(), rnr::WinButton::m_eAlign, rnr::WinButton::m_eType, rnr::WinButton::m_nEvent, rnr::WinButton::m_strAltText, rnr::WinButtonTypeImage, and rnr::WinButtonTypeLabel.

{
  MapBttns_T::iterator  iter;
  WinButton            *pButton;

  if( pWin == NULL )
  {
    LOGERROR("Binding window is NULL.");
    return;
  }

  // unbind any previous menu
  if( m_pWin != NULL )
  {
    unbind();
  }

  m_pWin = pWin;

  // add menu items to bound window
  for(iter=m_mapButtons.begin(); iter!=m_mapButtons.end(); ++iter)
  {
    pButton = iter->second;

    switch( pButton->m_eType )
    {
      case WinButtonTypeImage:
        m_pWin->addImageButton(pButton->m_nEvent,
                               pButton->m_eAlign,
                               pButton->getCurrentImageWidget(),
                               pButton->m_strAltText,
                               pButton->getCurrentToolTip());
        break;
      case WinButtonTypeLabel:
        m_pWin->addLabelButton(pButton->m_nEvent,
                               pButton->m_eAlign,
                               pButton->getCurrentLabel(),
                               pButton->getCurrentToolTip());
        break;
      default:
        break;
    }
  }

  // reset menu item states
  resetAllButtonStates();

  // register menu button press callback
  m_pWin->registerButtonClickCallback(WinButtonMenu::onMenuButtonClick, this);
}

void WinButtonMenu::changeButtonState ( WinButton *  pButton, WidgetState  eNewState  )

protected

Change the state and gui look of the given button.

Parameters

pButton	Pointer to menu button instance.
eNewState	New button state. See rnmpwin_widgetstate

Definition at line 338 of file WinMenu.cxx.

References rnr::WinButton::getActiveImageWidget(), rnr::WinButton::getNormalImageWidget(), rnr::WinButton::m_eState, rnr::WinButton::m_eType, rnr::WinButton::m_nEvent, rnr::WinButton::m_strTagActive, rnr::WinButton::m_strTagNormal, rnr::WinButton::m_strToolTipActive, rnr::WinButton::m_strToolTipNormal, rnr::WidgetStateActive, rnr::WinButtonTypeImage, and rnr::WinButtonTypeLabel.

Referenced by onMenuButtonClick().

{
  WidgetState   eCurState;

  eCurState         = pButton->m_eState;
  pButton->m_eState = eNewState;

  if( m_pWin != NULL )
  {
    switch( pButton->m_eType )
    {
      case WinButtonTypeImage:
        if( pButton->getActiveImageWidget() != NULL )
        {
          // normal,disabled --> active
          if( (eCurState != WidgetStateActive) &&
              (eNewState == WidgetStateActive) )
          {
            m_pWin->replaceButtonImage(pButton->m_nEvent,
                                       pButton->getActiveImageWidget(),
                                       pButton->m_strToolTipActive);
          }
          // active --> normal,disabled
          else if( (eCurState == WidgetStateActive) &&
                   (eNewState != WidgetStateActive) )
          {
            m_pWin->replaceButtonImage(pButton->m_nEvent,
                                       pButton->getNormalImageWidget(),
                                       pButton->m_strToolTipNormal);
          }
        }
        break;
      case WinButtonTypeLabel:
        if( !pButton->m_strTagActive.empty() )
        {
          // normal,disabled --> active
          if( (eCurState != WidgetStateActive) &&
              (eNewState == WidgetStateActive) )
          {
            m_pWin->replaceButtonLabel(pButton->m_nEvent,
                                       pButton->m_strTagActive,
                                       pButton->m_strToolTipActive);
          }
          // active --> normal,disabled
          else if( (eCurState == WidgetStateActive) &&
                   (eNewState != WidgetStateActive) )
          {
            m_pWin->replaceButtonImage(pButton->m_nEvent,
                                       pButton->m_strTagNormal,
                                       pButton->m_strToolTipNormal);
          }
        }
        break;
    }

    // show gui widget state
    m_pWin->showButtonState(pButton->m_nEvent, eNewState);
  }
}

WidgetState rnr::WinButtonMenu::getButtonState ( int  nEvent )

inline

Get the given button state.

Parameters

nEvent

Menu-wide unique event button identifier.

Returns

Current button state. See rnmpwin_widgetstate

Definition at line 439 of file WinMenu.h.

References rnr::WidgetStateNormal.

    {
      WidgetState eState = WidgetStateNormal;

      if( m_mapButtons.find(nEvent) != m_mapButtons.end() )
      {
        eState = m_mapButtons[nEvent]->m_eState;
      }
      return eState;
    }

int rnr::WinButtonMenu::getCurrentEvent ( )

inline

Get the current button menu event.

Returns

Current event.

Definition at line 390 of file WinMenu.h.

    {
      return m_nCurrentEvent;
    }

std::string rnr::WinButtonMenu::getIconPath ( )

inline

Get icon search path.

Returns

Icon path string.

Definition at line 305 of file WinMenu.h.

    {
      return m_strIconPath;
    }

size_t rnr::WinButtonMenu::getNumMenuButtons ( )

inline

Get the current number of menu items;.

Returns

Number of items.

Definition at line 427 of file WinMenu.h.

    {
      return m_mapButtons.size();
    }

int rnr::WinButtonMenu::getPreviousEvent ( )

inline

Get the previous menu event.

Returns

Current action.

Definition at line 417 of file WinMenu.h.

    {
      return m_nPreviousEvent;
    }

string WinButtonMenu::makeIconPath ( const std::string &  strIconFile )

protected

Make icon image file path.

The built file path is check of existence.

Parameters

strIconFile

Icon file absolute or relative file name.

Returns

Returns string containing icon path. Empty if no file specified or found.

Definition at line 275 of file WinMenu.cxx.

{
  string  strPath;                      // working path of search directories
  string  strIconFqName;                // icon fully-qualified file name
  size_t  pos1;                         // substring starting position 1
  size_t  pos2;                         // substring ending position 2

  //
  // No file name. Note this is not an error.
  //
  if( strIconFile.empty() )
  {
    return strIconFqName;
  }

  //
  // Icon file name is an absolute path.
  //
  if( strIconFile[0] == DIR_SEP_CHAR )
  {
    strIconFqName = strIconFile;
    if( access(strIconFqName.c_str(), F_OK|R_OK) != 0 )
    {
      LOGWARN("%s: %s(errno=%d)",
          strIconFqName.c_str(), strerror(errno), errno);
      strIconFqName.clear();
    }
    return strIconFqName;
  }

  //
  // Search for file.
  //
  if( m_strIconPath.empty() )
  {
    strPath = ".";
  }
  else
  {
    strPath = m_strIconPath + PATH_SEP_STR + ".";
  }

  for(pos1=0, pos2=strPath.find(PATH_SEP_STR, pos1);
      pos1 != strPath.npos;
      pos1=pos2+1, pos2=strPath.find(PATH_SEP_STR, pos1))
  {
    strIconFqName = strPath.substr(pos1, pos2) + DIR_SEP_STR + strIconFile; 
    if( access(strIconFqName.c_str(), F_OK|R_OK) == 0 )
    {
      return strIconFqName;
    }
  }

  //
  // Failed to find icon file.
  //
  LOGWARN("%s: Icon not found in %s.", strIconFile.c_str(), strPath.c_str());

  strIconFqName.clear();

  return strIconFqName;
}

void WinButtonMenu::onMenuButtonClick ( int  nEvent, void *  user_data  )

staticprotected

Menu button press callback.

Parameters

nEvent	Button event (and button id).
user_data	User-supplied data (this).

Definition at line 398 of file WinMenu.cxx.

References changeButtonState(), m_mapButtons, setCurrentEvent(), rnr::WidgetStateActive, and rnr::WidgetStateNormal.

{
  WinButtonMenu        *pMenu = (WinButtonMenu *)user_data;
  MapBttns_T::iterator  pos;
  WidgetState           eState;

  pMenu->setCurrentEvent(nEvent);
  
  if( (pos = pMenu->m_mapButtons.find(nEvent)) != pMenu->m_mapButtons.end() )
  {
    eState = pos->second->m_eState;

    // toggle state
    if( eState == WidgetStateNormal )
    {
      pMenu->changeButtonState(pos->second, WidgetStateActive);
    }
    else if( eState == WidgetStateActive )
    {
      pMenu->changeButtonState(pos->second, WidgetStateNormal);
    }
  }
}

void rnr::WinButtonMenu::prependIconDir ( const std::string &  strIconDir )

inline

Prepend directory to icon search path.

Parameters

strIconDir

Directory holding icons.

Definition at line 278 of file WinMenu.h.

    {
      if( m_strIconPath.empty() )
      {
        m_strIconPath = strIconDir;
      }
      else
      {
        m_strIconPath = strIconDir + PATH_SEP_STR + m_strIconPath;
      }
    }

void rnr::WinButtonMenu::setButtonState ( int  nEvent, WidgetState  eNewState  )

inline

Set the given button state.

Parameters

nEvent	Menu-wide unique event button identifier.
eNewState	New button state. See rnmpwin_widgetstate

Definition at line 456 of file WinMenu.h.

    {
      MapBttns_T::iterator  pos;
      
      if( (pos = m_mapButtons.find(nEvent)) != m_mapButtons.end() )
      {
        changeButtonState(pos->second, eNewState);
      }
    }

void WinButtonMenu::setButtonStateList	(	const std::string &	strEvent,
			...
	)

Set the states of the given buttons.

Parameters

strEvent	Event reason string (used for logging only).
...	Sequence of event,state pairs. The sequence is terminated by the UIEventNone special 'no' action event.

Definition at line 229 of file WinMenu.cxx.

References rnr::UIEventNone.

{
  va_list               ap;
  size_t                i;
  int                   nEvent;
  WidgetState           eNewState;
  MapBttns_T::iterator  pos;

  LOGDIAG3("'%s' bulk menu state changes.", strEvent.c_str());

  va_start(ap, strEvent);

  //
  // Loop through button map, but limit to number of buttons.
  //
  for(i=0; i<m_mapButtons.size(); ++i)
  {
    nEvent   = va_arg(ap, int);

    // stop criteria
    if( nEvent == UIEventNone )
    {
      break;
    }

    eNewState = (WidgetState)va_arg(ap, int);

    if( (pos = m_mapButtons.find(nEvent)) != m_mapButtons.end() )
    {
      changeButtonState(pos->second, eNewState);
    }
  }

  va_end(ap);
}

int rnr::WinButtonMenu::setCurrentEvent ( int  nNewEvent )

inline

Set the current button menu event.

Parameters

nNewEvent

New event unique identifier.

Returns

New current event.

Definition at line 402 of file WinMenu.h.

Referenced by onMenuButtonClick().

    {
      if( nNewEvent != m_nCurrentEvent )
      {
        m_nPreviousEvent = m_nCurrentEvent;
      }
      m_nCurrentEvent = nNewEvent;
      return m_nCurrentEvent;
    }

void rnr::WinButtonMenu::setIconPath ( const std::string &  strIconPath )

inline

Set icon search path.

Parameters

strIconPath

Icon path of search directories.

Definition at line 295 of file WinMenu.h.

    {
      m_strIconPath = strIconPath;
    }

---

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

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