#include <windowmenu.h>

Inheritance diagram for WindowMenu:

Public Member Functions
	WindowMenu (const Widget2 *const widget)

	~WindowMenu ()

void	action (const ActionEvent &event)

void	mousePressed (MouseEvent &event)

void	mouseMoved (MouseEvent &event)

void	mouseExited (MouseEvent &event)

std::map< std::string, ButtonInfo * > &	getButtonNames ()

std::vector< Button * > &	getButtons ()

std::vector< ButtonText * > &	getButtonTexts ()

void	showButton (const std::string &name, const Visible visible)

void	loadButtons ()

void	saveButtons () const

void	optionChanged (const std::string &name)

Public Member Functions inherited from Container
	Container (const Widget2 *const widget)

	~Container ()

bool	safeRemove (Widget *const widget)

void	removeControls ()

Public Member Functions inherited from BasicContainer2
	BasicContainer2 (const Widget2 *const widget)

	~BasicContainer2 ()

void	setOpaque (Opaque opaque)

bool	isOpaque () const

virtual void	add (Widget *const widget)

void	addXY (Widget *const widget, const int x, const int y)

void	draw (Graphics *const graphics)

void	safeDraw (Graphics *const graphics)

Public Member Functions inherited from BasicContainer
	BasicContainer (const Widget2 *const widget)

	~BasicContainer ()

void	showWidgetPart (Widget *const widget, const Rect &area)

void	moveToTop (Widget *const widget)

void	moveToBottom (Widget *const widget)

Rect	getChildrenArea ()

void	focusNext ()

void	focusPrevious ()

void	logic ()

void	setFocusHandler (FocusHandler *const focusHandler)

void	setInternalFocusHandler (FocusHandler *const focusHandler)

Widget *	getWidgetAt (int x, int y)

void	death (const Event &event)

Widget *	findFirstWidget (const std::set< Widget * > &list)

void	add (Widget *const widget)

virtual void	remove (Widget *const widget)

virtual void	clear ()

Public Member Functions inherited from Widget
	Widget (const Widget2 *const widget)

	~Widget ()

virtual void	drawFrame (Graphics *graphics)

virtual void	safeDrawFrame (Graphics *graphics)

void	setFrameSize (const unsigned int frameSize)

unsigned int	getFrameSize () const

Widget *	getParent () const

void	setWidth (const int width)

int	getWidth () const

void	setHeight (const int height)

int	getHeight () const

void	setSize (const int width, const int height)

void	setX (const int x)

int	getX () const

void	setY (const int y)

int	getY () const

void	setPosition (const int x, const int y)

void	setDimension (const Rect &dimension)

const Rect &	getDimension () const

void	setFocusable (const bool focusable)

bool	isFocusable () const

virtual bool	isFocused () const

void	setEnabled (const bool enabled)

bool	isEnabled () const

void	setVisible (Visible visible)

bool	isVisible () const

void	setBaseColor (const Color &color)

const Color &	getBaseColor () const

void	setForegroundColor (const Color &color)

const Color &	getForegroundColor () const

void	setBackgroundColor (const Color &color)

const Color &	getBackgroundColor () const

virtual void	requestFocus ()

virtual void	requestMoveToTop ()

virtual void	requestMoveToBottom ()

FocusHandler *	getFocusHandler ()

void	addActionListener (ActionListener *const actionListener)

void	removeActionListener (ActionListener *const actionListener)

void	addDeathListener (WidgetDeathListener *const deathListener)

void	removeDeathListener (WidgetDeathListener *const deathListener)

void	addMouseListener (MouseListener *const mouseListener)

void	removeMouseListener (MouseListener *const mouseListener)

void	addKeyListener (KeyListener *const keyListener)

void	removeKeyListener (KeyListener *const keyListener)

void	addFocusListener (FocusListener *const focusListener)

void	removeFocusListener (FocusListener *const focusListener)

void	addWidgetListener (WidgetListener *const widgetListener)

void	removeWidgetListener (WidgetListener *const widgetListener)

void	setActionEventId (const std::string &actionEventId)

const std::string &	getActionEventId () const

virtual void	getAbsolutePosition (int &x, int &y) const

virtual void	setParent (Widget *parent)

Font *	getFont () const

void	setFont (Font *const font)

virtual void	fontChanged ()

bool	isTabInEnabled () const

void	setTabInEnabled (const bool enabled)

bool	isTabOutEnabled () const

void	setTabOutEnabled (const bool enabled)

void	requestModalFocus ()

virtual void	requestModalMouseInputFocus ()

virtual void	releaseModalFocus ()

virtual void	releaseModalMouseInputFocus ()

virtual bool	isModalFocused () const

virtual bool	isModalMouseInputFocused () const

const std::list< MouseListener * > &	getMouseListeners () const A_CONST

const std::list< KeyListener * > &	getKeyListeners () const A_CONST

const std::list< FocusListener * > &	getFocusListeners () const A_CONST

virtual FocusHandler *	getInternalFocusHandler ()

void	setInternalFocusHandler (FocusHandler *const internalFocusHandler)

void	setId (const std::string &id)

const std::string &	getId () const

virtual void	showPart (const Rect &rectangle)

bool	isAllowLogic () const

void	setMouseConsume (const bool b)

bool	isMouseConsume () const

void	setRedraw (const bool b)

virtual bool	isSelectable () const

void	setSelectable (const bool selectable)

void	windowResized ()

virtual void	postInit ()

Public Member Functions inherited from Widget2
virtual	~Widget2 ()

const Color &	getThemeColor (const ThemeColorIdT type, const unsigned int alpha) const A_INLINE

const Color &	getThemeCharColor (const signed char c, bool &valid) const A_INLINE

virtual void	setWidget2 (const Widget2 *const widget)

void	setPalette (int palette)

void	checkPalette ()

void	setForegroundColor2 (const Color &color)

Widget *	getWindow () const

virtual void	setWindow (Widget *const window)

Public Member Functions inherited from WidgetDeathListener
virtual	~WidgetDeathListener ()

Public Member Functions inherited from ConfigListener
	ConfigListener ()

virtual	~ConfigListener ()

Public Member Functions inherited from ActionListener
virtual	~ActionListener ()

Public Member Functions inherited from SelectionListener
virtual	~SelectionListener ()

virtual void	valueChanged (const SelectionEvent &event)

Public Member Functions inherited from MouseListener
virtual	~MouseListener ()

virtual void	mouseEntered (MouseEvent &event)

virtual void	mouseReleased (MouseEvent &event)

virtual void	mouseClicked (MouseEvent &event)

virtual void	mouseWheelMovedUp (MouseEvent &event)

virtual void	mouseWheelMovedDown (MouseEvent &event)

virtual void	mouseDragged (MouseEvent &event)

Protected Member Functions
void	drawChildren (Graphics *const graphics)

void	safeDrawChildren (Graphics *const graphics)

Protected Member Functions inherited from BasicContainer
virtual void	logicChildren ()

Protected Member Functions inherited from Widget
void	distributeActionEvent ()

void	distributeResizedEvent ()

void	distributeMovedEvent ()

void	distributeHiddenEvent ()

void	distributeShownEvent ()

Protected Member Functions inherited from Widget2
	Widget2 (const Widget2 *const widget)

Protected Member Functions inherited from WidgetDeathListener
	WidgetDeathListener ()

Protected Member Functions inherited from ActionListener
	ActionListener ()

Protected Member Functions inherited from SelectionListener
	SelectionListener ()

Protected Member Functions inherited from MouseListener
	MouseListener ()

Private Member Functions
void	addButton (const char *const text, const int iconNumber, const std::string &description, int &x, int &h, const InputActionT key, const Visible visible)

void	updateButtons ()

Private Attributes
Skin *	mSkin

ImageSet *	mImageSet

int	mPadding

int	mSpacing

std::vector< Button * >	mButtons

std::vector< ButtonText * >	mButtonTexts

std::map< std::string, ButtonInfo * >	mButtonNames

bool	mHaveMouse

int	mAutoHide

bool	mSmallWindow

Additional Inherited Members
Static Public Member Functions inherited from Widget
static void	setGlobalFont (Font *const font)

static Font *	getGloablFont ()

static void	cleanGlobalFont ()

static bool	widgetExists (const Widget *const widget)

static void	distributeWindowResizeEvent ()

static Widget *	callPostInit (Widget *const widget)

Data Fields inherited from Widget
Visible	mVisible

Protected Types inherited from BasicContainer
typedef std::vector< Widget * >	WidgetList

typedef WidgetList::iterator	WidgetListIterator

typedef WidgetList::const_iterator	WidgetListConstIterator

typedef WidgetList::reverse_iterator	WidgetListReverseIterator

typedef WidgetList::const_reverse_iterator	WidgetListCReverseIterator

Protected Types inherited from Widget
typedef std::list< MouseListener * >	MouseListenerList

typedef MouseListenerList::iterator	MouseListenerIterator

typedef std::list< KeyListener * >	KeyListenerList

typedef KeyListenerList::iterator	KeyListenerIterator

typedef std::list< ActionListener * >	ActionListenerList

typedef ActionListenerList::iterator	ActionListenerIterator

typedef std::list< WidgetDeathListener * >	WidgetDeathListenerList

typedef WidgetDeathListenerList::iterator	WidgetDeathListenerIterator

typedef std::list< FocusListener * >	FocusListenerList

typedef FocusListenerList::iterator	FocusListenerIterator

typedef std::list< WidgetListener * >	WidgetListenerList

typedef WidgetListenerList::iterator	WidgetListenerIterator

Protected Attributes inherited from BasicContainer2
Opaque	mOpaque

Protected Attributes inherited from BasicContainer
WidgetList	mWidgets

WidgetList	mLogicWidgets

Protected Attributes inherited from Widget
MouseListenerList	mMouseListeners

KeyListenerList	mKeyListeners

ActionListenerList	mActionListeners

WidgetDeathListenerList	mDeathListeners

FocusListenerList	mFocusListeners

WidgetListenerList	mWidgetListeners

Color	mForegroundColor

Color	mBackgroundColor

Color	mBaseColor

Rect	mDimension

std::string	mActionEventId

std::string	mId

FocusHandler *	mFocusHandler

FocusHandler *	mInternalFocusHandler

Widget *	mParent

Font *	mCurrentFont

unsigned int	mFrameSize

bool	mFocusable

bool	mTabIn

bool	mTabOut

bool	mEnabled

bool	mAllowLogic

bool	mMouseConsume

bool	mRedraw

bool	mSelectable

Protected Attributes inherited from Widget2
int	mPaletteOffset

Widget *	mWindow

Color	mForegroundColor2

Static Protected Attributes inherited from Widget
static Font *	mGlobalFont = 0

Detailed Description

The window menu. Allows showing and hiding many of the different windows used in the game.

Definition at line 49 of file windowmenu.h.

Constructor & Destructor Documentation

◆ WindowMenu()

WindowMenu::WindowMenu ( const Widget2 *const widget )

explicit

Definition at line 53 of file windowmenu.cpp.

                                                   :
     Container(widget),
     ConfigListener(),
     ActionListener(),
     SelectionListener(),
     MouseListener(),
     mSkin(theme != nullptr ? theme->load("windowmenu.xml", "",
         true, Theme::getThemePath()) : nullptr),
     mImageSet(nullptr),
     mPadding(mSkin != nullptr ? mSkin->getPadding() : 1),
     mSpacing(mSkin != nullptr ? mSkin->getOption("spacing", 3) : 3),
     mButtons(),
     mButtonTexts(),
     mButtonNames(),
     mHaveMouse(false),
     mAutoHide(1),
     mSmallWindow(mainGraphics->getWidth() < 600)
 {
     int x = mPadding;
     int h = 0;
  
     setFocusable(false);
  
     if (settings.showButtonIcons)
     {
         mImageSet = Theme::getImageSetFromTheme("buttonsicons.png",
             mSkin->getOption("imageWidth", 20),
             mSkin->getOption("imageHeight", 20));
     }
  
     // TRANSLATORS: short button name for who is online window.
     addButton(N_("ONL"),
         13,
         // TRANSLATORS: long button name for who is online window.
         _("Who is online"), x, h, InputAction::WINDOW_ONLINE,
         Visible_true);
     // TRANSLATORS: short button name for help window.
     addButton(N_("HLP"),
         0,
         // TRANSLATORS: long button name for help window.
         _("Help"), x, h, InputAction::WINDOW_HELP,
         Visible_true);
     // TRANSLATORS: short button name for quests window.
     addButton(N_("QE"),
         12,
         // TRANSLATORS: long button name for quests window.
         _("Quests"), x, h, InputAction::WINDOW_QUESTS,
         Visible_true);
     // TRANSLATORS: short button name for kill stats window.
     addButton(N_("KS"),
         16,
         // TRANSLATORS: long button name for kill stats window.
         _("Kill stats"), x, h, InputAction::WINDOW_KILLS,
         Visible_true);
     addButton(":-)",
         6,
         // TRANSLATORS: long button name for emotes window.
         _("Smilies"), x, h, InputAction::WINDOW_EMOTE_SHORTCUT,
         Visible_true);
     // TRANSLATORS: short button name for chat window.
     addButton(N_("CH"),
         20,
         // TRANSLATORS: longt button name for chat window.
         _("Chat"), x, h, InputAction::WINDOW_CHAT,
 #ifdef ANDROID
         Visible_true);
 #else  // ANDROID
         Visible_false);
 #endif  // ANDROID
  
     // TRANSLATORS: short button name for status window.
     addButton(N_("STA"),
         17,
         // TRANSLATORS: long button name for status window.
         _("Status"), x, h, InputAction::WINDOW_STATUS,
         Visible_true);
     // TRANSLATORS: short button name for equipment window.
     addButton(N_("EQU"),
         7,
         // TRANSLATORS: long button name for equipment window.
         _("Equipment"), x, h, InputAction::WINDOW_EQUIPMENT,
         Visible_true);
     // TRANSLATORS: short button name for inventory window.
     addButton(N_("INV"),
         9,
         // TRANSLATORS: long button name for inventory window.
         _("Inventory"), x, h, InputAction::WINDOW_INVENTORY,
         Visible_true);
     // TRANSLATORS: short button name for cart window.
     addButton(N_("CA"),
         11,
         // TRANSLATORS: long button name for cart window.
         _("Cart"), x, h, InputAction::WINDOW_CART,
         Visible_true);
     // TRANSLATORS: short button name for map window.
     addButton(N_("MAP"),
         19,
         // TRANSLATORS: long button name for map window.
         _("Map"), x, h, InputAction::WINDOW_MINIMAP,
         Visible_false);
  
     if (skillDialog->hasSkills())
     {
         // TRANSLATORS: short button name for skills window.
         addButton(N_("SKI"),
             5,
             // TRANSLATORS: long button name for skills window.
             _("Skills"), x, h, InputAction::WINDOW_SKILL,
         Visible_true);
     }
  
     // TRANSLATORS: short button name for social window.
     addButton(N_("SOC"),
         1,
         // TRANSLATORS: long button name for social window.
         _("Social"), x, h, InputAction::WINDOW_SOCIAL,
         Visible_true);
     // TRANSLATORS: short button name for shortcuts window.
     addButton(N_("SH"),
         14,
         // TRANSLATORS: long button name for shortcuts window.
         _("Shortcuts"), x, h, InputAction::WINDOW_SHORTCUT,
         Visible_true);
     // TRANSLATORS: short button name for spells window.
     addButton(N_("SP"),
         15,
         // TRANSLATORS: long button name for spells window.
         _("Spells"), x, h, InputAction::WINDOW_SPELLS,
         Visible_true);
     // TRANSLATORS: short button name for drops window.
     addButton(N_("DR"),
         26,
         // TRANSLATORS: long button name for drops window.
         _("Drop"), x, h, InputAction::WINDOW_DROP,
         Visible_false);
     // TRANSLATORS: short button name for did you know window.
     addButton(N_("YK"),
         24,
         // TRANSLATORS: long button name for did you know window.
         _("Did you know"), x, h, InputAction::WINDOW_DIDYOUKNOW,
         Visible_false);
     // TRANSLATORS: short button name for shop window.
     addButton(N_("SHP"),
         18,
         // TRANSLATORS: long button name for shop window.
         _("Shop"), x, h, InputAction::WINDOW_SHOP,
         Visible_false);
     // TRANSLATORS: short button name for outfits window.
     addButton(N_("OU"),
         21,
         // TRANSLATORS: long button name for outfits window.
         _("Outfits"), x, h, InputAction::WINDOW_OUTFIT,
         Visible_false);
     // TRANSLATORS: short button name for updates window.
     addButton(N_("UP"),
         25,
         // TRANSLATORS: long button name for updates window.
         _("Updates"), x, h, InputAction::WINDOW_UPDATER,
         Visible_false);
     // TRANSLATORS: short button name for bank window.
     addButton(N_("BA"),
         2,
         // TRANSLATORS: long button name for bank window.
         _("Bank"), x, h, InputAction::WINDOW_BANK,
         Visible_true);
     // TRANSLATORS: short button name for mail window.
     addButton(N_("MA"),
         10,
         // TRANSLATORS: long button name for mail window.
         _("Mail"), x, h, InputAction::WINDOW_MAIL,
         Visible_true);
     // TRANSLATORS: short button name for clan window.
     addButton(N_("CL"),
         4,
         // TRANSLATORS: long button name for clan window.
         _("Clan"), x, h, InputAction::WINDOW_CLAN,
         Visible_true);
     // TRANSLATORS: short button name for server info window.
     addButton(N_("SI"),
         8,
         // TRANSLATORS: long button name for server info window.
         _("Server info"), x, h, InputAction::WINDOW_SERVER_INFO,
         Visible_true);
     // TRANSLATORS: short button name for debug window.
     addButton(N_("DBG"),
         22,
         // TRANSLATORS: long button name for debug window.
         _("Debug"), x, h, InputAction::WINDOW_DEBUG,
 #ifdef ANDROID
         Visible_true);
 #else  // ANDROID
         Visible_false);
 #endif  // ANDROID
  
     // TRANSLATORS: short button name for windows list menu.
     addButton(N_("WIN"),
         23,
         // TRANSLATORS: long button name for windows list menu.
         _("Windows"), x, h, InputAction::SHOW_WINDOWS,
         Visible_false);
     // TRANSLATORS: short button name for setup window.
     addButton(N_("SET"),
         3,
         // TRANSLATORS: long button name for setup window.
         _("Setup"), x, h, InputAction::WINDOW_SETUP,
         Visible_true);
  
     x += mPadding - mSpacing;
     if (mainGraphics != nullptr)
         setDimension(Rect(mainGraphics->mWidth - x, 0, x, h));
  
     loadButtons();
  
     addMouseListener(this);
     setVisible(Visible_true);
  
     config.addListener("autohideButtons", this);
     mAutoHide = config.getIntValue("autohideButtons");
 }

◆ ~WindowMenu()

WindowMenu::~WindowMenu ( )

Definition at line 273 of file windowmenu.cpp.

 {
     config.removeListener("autohideButtons", this);
     CHECKLISTENERS
  
     for (std::map <std::string, ButtonInfo*>::iterator
          it = mButtonNames.begin(),
          it_fend = mButtonNames.end(); it != it_fend; ++it)
     {
         delete (*it).second;
     }
     mButtonNames.clear();
     FOR_EACH (STD_VECTOR <Button*>::iterator, it, mButtons)
     {
         Button *const btn = *it;
         if (btn == nullptr)
             continue;
         if (btn->mVisible == Visible_false)
             delete btn;
     }
     delete_all(mButtonTexts);
     mButtonTexts.clear();
     if (mImageSet != nullptr)
     {
         mImageSet->decRef();
         mImageSet = nullptr;
     }
     if (mSkin != nullptr)
     {
         if (theme != nullptr)
             theme->unload(mSkin);
         mSkin = nullptr;
     }
 }

References CHECKLISTENERS, config, Resource::decRef(), delete_all(), FOR_EACH, mButtonNames, mButtons, mButtonTexts, mImageSet, mSkin, Widget::mVisible, Configuration::removeListener(), theme, Theme::unload(), and Visible_false.

Member Function Documentation

◆ action()

void WindowMenu::action ( const ActionEvent & actionEvent )

virtual

Called when an action is recieved from a widget. It is used to be able to recieve a notification that an action has occured.

Parameters

actionEvent The event of the action.

Implements ActionListener.

Definition at line 308 of file windowmenu.cpp.

 {
     const std::string &eventId = event.getId();
     const std::map <std::string, ButtonInfo*>::iterator
         it = mButtonNames.find(eventId);
     if (it == mButtonNames.end())
         return;
  
     const ButtonInfo *const info = (*it).second;
     if (info == nullptr)
         return;
  
     inputManager.executeAction(info->key);
 }

References InputManager::executeAction(), Actions::info(), inputManager, and mButtonNames.

◆ addButton()

void WindowMenu::addButton	(	const char *const	text,
		const int	iconNumber,
		const std::string &	description,
		int &	x,
		int &	h,
		const InputActionT	key,
		const Visible	visible
	)

inlineprivate

Definition at line 323 of file windowmenu.cpp.

 {
     Button *btn = nullptr;
     if (settings.showButtonIcons &&
         mImageSet)
     {
         Image *const image = mImageSet->get(iconNumber);
         if (image != nullptr)
         {
 /*
             btn = new Button(this,
                 "buttonsicons.png",
                 20,
                 20,
                 text,
                 BUTTON_SKIN,
                 this);
 */
             btn = new Button(this,
                 std::string(),
                 text,
                 BUTTON_SKIN,
                 this);
             btn->setImage(image);
             btn->adjustSize();
         }
     }
     if (btn == nullptr)
     {
         btn = new Button(this,
             gettext(text),
             text,
             BUTTON_SKIN,
             this);
     }
     btn->setPosition(x, mPadding);
     btn->setDescription(description);
     btn->setTag(CAST_S32(key));
     add(btn);
     btn->setFocusable(false);
     x += btn->getWidth() + mSpacing;
     h = btn->getHeight() + 2 * mPadding;
     mButtons.push_back(btn);
     mButtonNames[text] = new ButtonInfo(btn, key, visible);
     if (key != InputAction::SHOW_WINDOWS)
         mButtonTexts.push_back(new ButtonText(description, key));
 }

References BasicContainer2::add(), Button::adjustSize(), BUTTON_SKIN, CAST_S32, ImageSet::get(), Widget::getHeight(), Widget::getWidth(), mButtonNames, mButtons, mButtonTexts, mImageSet, mPadding, mSpacing, Button::setDescription(), Widget::setFocusable(), Button::setImage(), Widget::setPosition(), Button::setTag(), settings, InputAction::SHOW_WINDOWS, Settings::showButtonIcons, and x.

Referenced by WindowMenu().

◆ drawChildren()

void WindowMenu::drawChildren ( Graphics *const graphics )

protectedvirtual

Draws the children widgets of the basic container.

Parameters

graphics A graphics object to draw with.

Reimplemented from BasicContainer.

Definition at line 554 of file windowmenu.cpp.

 {
     if (mHaveMouse ||
         mAutoHide == 0 ||
         (mAutoHide == 1 &&
         mainGraphics != nullptr &&
         (mSmallWindow || mainGraphics->mWidth > 800)))
     {
         Container::drawChildren(graphics);
     }
 }

References BasicContainer::drawChildren(), mainGraphics, mAutoHide, mHaveMouse, mSmallWindow, and Graphics::mWidth.

◆ getButtonNames()

std::map<std::string, ButtonInfo*>& WindowMenu::getButtonNames ( )

inline

Definition at line 70 of file windowmenu.h.

71 { return mButtonNames; }

References mButtonNames.

◆ getButtons()

std::vector<Button*>& WindowMenu::getButtons ( )

inline

Definition at line 73 of file windowmenu.h.

74 { return mButtons; }

References mButtons.

Referenced by PopupMenu::showPopup().

◆ getButtonTexts()

std::vector<ButtonText*>& WindowMenu::getButtonTexts ( )

inline

Definition at line 76 of file windowmenu.h.

77 { return mButtonTexts; }

References mButtonTexts.

Referenced by PopupMenu::showWindowsPopup().

◆ loadButtons()

void WindowMenu::loadButtons ( )

Definition at line 484 of file windowmenu.cpp.

 {
     if (!mSmallWindow)
     {
         if (config.getValue("windowmenu0", "").empty())
         {
             for (std::map <std::string, ButtonInfo*>::iterator
                  it = mButtonNames.begin(),
                  it_fend = mButtonNames.end(); it != it_fend; ++it)
             {
                 const ButtonInfo *const info = (*it).second;
                 if (info == nullptr ||
                     info->button == nullptr ||
                     info->visible == Visible_true)
                 {
                     continue;
                 }
                 info->button->setVisible(Visible_false);
             }
             updateButtons();
             return;
         }
  
         for (int f = 0; f < 30; f ++)
         {
             const std::string str = config.getValue(
                 "windowmenu" + toString(f), "");
             if (str.empty() || str == "SET")
                 continue;
             const ButtonInfo *const info = mButtonNames[str];
             if ((info == nullptr) || (info->button == nullptr))
                 continue;
             info->button->setVisible(Visible_false);
         }
     }
     else
     {
         for (std::map <std::string, ButtonInfo*>::iterator
              it = mButtonNames.begin(),
              it_fend = mButtonNames.end(); it != it_fend; ++it)
         {
             const ButtonInfo *const info = (*it).second;
             if ((info == nullptr) || (info->button == nullptr))
                 continue;
             Button *const button = info->button;
             const std::string &str = button->getActionEventId();
             button->setVisible(fromBool(
                 str == "SET" || str == "WIN", Visible));
         }
     }
     updateButtons();
 }

References config, fromBool, Widget::getActionEventId(), ConfigurationObject::getValue(), Actions::info(), mButtonNames, mSmallWindow, Widget::setVisible(), Catch::toString(), updateButtons(), Visible_false, and Visible_true.

Referenced by WindowMenu().

◆ mouseExited()

void WindowMenu::mouseExited ( MouseEvent & event )

virtual

Called when the mouse has exited the widget area.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 438 of file windowmenu.cpp.

 {
     mHaveMouse = false;
     if (textPopup == nullptr)
         return;
  
     textPopup->hide();
 }

References Popup::hide(), mHaveMouse, and textPopup.

◆ mouseMoved()

void WindowMenu::mouseMoved ( MouseEvent & event )

virtual

Called when the mouse has moved in the widget area and no mouse button has been pressed (i.e no widget is being dragged).

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 399 of file windowmenu.cpp.

 {
     mHaveMouse = true;
  
     if (textPopup == nullptr)
         return;
  
     if (event.getSource() == this)
     {
         textPopup->hide();
         return;
     }
  
     const Button *const btn = dynamic_cast<const Button *>(
         event.getSource());
  
     if (btn == nullptr)
     {
         textPopup->hide();
         return;
     }
  
     const int x = event.getX();
     const int y = event.getY();
     const InputActionT key = static_cast<InputActionT>(btn->getTag());
     const Rect &rect = mDimension;
     if (key != InputAction::NO_VALUE)
     {
         textPopup->show(x + rect.x, y + rect.y, btn->getDescription(),
             // TRANSLATORS: short key name
             strprintf(_("Key: %s"), inputManager.getKeyValueString(
             key).c_str()));
     }
     else
     {
         textPopup->show(x + rect.x, y + rect.y, btn->getDescription());
     }
 }

References _, Button::getDescription(), InputManager::getKeyValueString(), Event::getSource(), Button::getTag(), Popup::hide(), inputManager, Widget::mDimension, mHaveMouse, InputAction::NO_VALUE, TextPopup::show(), strprintf(), textPopup, Rect::x, x, Rect::y, and y.

◆ mousePressed()

void WindowMenu::mousePressed ( MouseEvent & event )

virtual

Called when a mouse button has been pressed on the widget area.

NOTE: A mouse press is NOT equal to a mouse click. Use mouseClickMessage to check for mouse clicks.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 377 of file windowmenu.cpp.

 {
     if (popupManager == nullptr)
         return;
  
     if (event.getButton() == MouseButton::RIGHT)
     {
         if (mSmallWindow)
             return;
  
         event.consume();
         Button *const btn = dynamic_cast<Button*>(event.getSource());
         if (btn == nullptr)
             return;
         if (popupMenu != nullptr)
         {
             popupMenu->showPopup(getX() + event.getX(),
                 getY() + event.getY(), btn);
         }
     }
 }

References MouseEvent::getButton(), Widget::getX(), Widget::getY(), mSmallWindow, popupManager, popupMenu, MouseButton::RIGHT, and PopupMenu::showPopup().

◆ optionChanged()

void WindowMenu::optionChanged ( const std::string & name )

virtual

Called when an option changed. The config listener will have to be registered to the option name first.

Implements ConfigListener.

Definition at line 578 of file windowmenu.cpp.

 {
     if (name == "autohideButtons")
         mAutoHide = config.getIntValue("autohideButtons");
 }

References config, Configuration::getIntValue(), and mAutoHide.

◆ safeDrawChildren()

void WindowMenu::safeDrawChildren ( Graphics *const graphics )

protectedvirtual

Reimplemented from BasicContainer.

Definition at line 566 of file windowmenu.cpp.

 {
     if (mHaveMouse ||
         mAutoHide == 0 ||
         (mAutoHide == 1 &&
         mainGraphics != nullptr &&
         (mSmallWindow || mainGraphics->mWidth > 800)))
     {
         Container::safeDrawChildren(graphics);
     }
 }

References mainGraphics, mAutoHide, mHaveMouse, mSmallWindow, Graphics::mWidth, and BasicContainer::safeDrawChildren().

◆ saveButtons()

void WindowMenu::saveButtons ( ) const

Definition at line 537 of file windowmenu.cpp.

 {
     int i = 0;
     FOR_EACH (STD_VECTOR <Button*>::const_iterator, it, mButtons)
     {
         const Button *const btn = *it;
         if ((btn != nullptr) && btn->mVisible == Visible_false)
         {
             config.setValue("windowmenu" + toString(i),
                 btn->getActionEventId());
             i ++;
         }
     }
     for (int f = i; f < 30; f ++)
         config.deleteKey("windowmenu" + toString(f));
 }

References config, ConfigurationObject::deleteKey(), FOR_EACH, Widget::getActionEventId(), mButtons, Widget::mVisible, Configuration::setValue(), Catch::toString(), and Visible_false.

Referenced by showButton().

◆ showButton()

void WindowMenu::showButton	(	const std::string &	name,
		const Visible	visible
	)

Definition at line 447 of file windowmenu.cpp.

 {
     const ButtonInfo *const info = mButtonNames[name];
     if ((info == nullptr) || (info->button == nullptr))
         return;
  
     info->button->setVisible(visible);
     updateButtons();
     saveButtons();
 }

References Actions::info(), mButtonNames, saveButtons(), and updateButtons().

Referenced by PopupMenu::handleLink().

◆ updateButtons()

void WindowMenu::updateButtons ( )

private

Definition at line 459 of file windowmenu.cpp.

 {
     int x = mPadding;
     int h = 0;
     FOR_EACH (STD_VECTOR <Button*>::const_iterator, it, mButtons)
         safeRemove(*it);
     const int pad2 = 2 * mPadding;
     FOR_EACH (STD_VECTOR <Button*>::iterator, it, mButtons)
     {
         Button *const btn = *it;
         if (btn == nullptr)
             continue;
         if (btn->mVisible == Visible_true)
         {
             btn->setPosition(x, mPadding);
             add(btn);
             x += btn->getWidth() + mSpacing;
             h = btn->getHeight() + pad2;
         }
     }
     x += mPadding - mSpacing;
     if (mainGraphics != nullptr)
         setDimension(Rect(mainGraphics->mWidth - x, 0, x, h));
 }

References BasicContainer2::add(), FOR_EACH, Widget::getHeight(), Widget::getWidth(), mainGraphics, mButtons, mPadding, mSpacing, Widget::mVisible, Graphics::mWidth, Container::safeRemove(), Widget::setDimension(), Widget::setPosition(), Visible_true, and x.

Referenced by loadButtons(), and showButton().

Field Documentation

◆ mAutoHide

int WindowMenu::mAutoHide

private

Definition at line 116 of file windowmenu.h.

Referenced by drawChildren(), optionChanged(), safeDrawChildren(), and WindowMenu().

◆ mButtonNames

std::map<std::string, ButtonInfo*> WindowMenu::mButtonNames

private

Definition at line 114 of file windowmenu.h.

Referenced by action(), addButton(), getButtonNames(), loadButtons(), showButton(), and ~WindowMenu().

◆ mButtons

std::vector<Button*> WindowMenu::mButtons

private

Definition at line 112 of file windowmenu.h.

Referenced by addButton(), getButtons(), saveButtons(), updateButtons(), and ~WindowMenu().

◆ mButtonTexts

std::vector<ButtonText*> WindowMenu::mButtonTexts

private

Definition at line 113 of file windowmenu.h.

Referenced by addButton(), getButtonTexts(), and ~WindowMenu().

◆ mHaveMouse

bool WindowMenu::mHaveMouse

private

Definition at line 115 of file windowmenu.h.

Referenced by drawChildren(), mouseExited(), mouseMoved(), and safeDrawChildren().

◆ mImageSet

ImageSet* WindowMenu::mImageSet

private

Definition at line 109 of file windowmenu.h.

Referenced by addButton(), WindowMenu(), and ~WindowMenu().

◆ mPadding

int WindowMenu::mPadding

private

Definition at line 110 of file windowmenu.h.

Referenced by addButton(), updateButtons(), and WindowMenu().

◆ mSkin

Skin* WindowMenu::mSkin

private

Definition at line 108 of file windowmenu.h.

Referenced by WindowMenu(), and ~WindowMenu().

◆ mSmallWindow

bool WindowMenu::mSmallWindow

private

Definition at line 117 of file windowmenu.h.

Referenced by drawChildren(), loadButtons(), mousePressed(), and safeDrawChildren().

◆ mSpacing

int WindowMenu::mSpacing

private

Definition at line 111 of file windowmenu.h.

Referenced by addButton(), updateButtons(), and WindowMenu().

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

src/gui/windowmenu.h (986a3bf)
src/gui/windowmenu.cpp (986a3bf)

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WindowMenu()

◆ ~WindowMenu()

Member Function Documentation

◆ action()

◆ addButton()

◆ drawChildren()

◆ getButtonNames()

◆ getButtons()

◆ getButtonTexts()

◆ loadButtons()

◆ mouseExited()

◆ mouseMoved()

◆ mousePressed()

◆ optionChanged()

◆ safeDrawChildren()

◆ saveButtons()

◆ showButton()

◆ updateButtons()

Field Documentation

◆ mAutoHide

◆ mButtonNames

◆ mButtons

◆ mButtonTexts

◆ mHaveMouse

◆ mImageSet

◆ mPadding

◆ mSkin

◆ mSmallWindow

◆ mSpacing