ManaPlus
Public Member Functions | Private Attributes
SpellPopup Class Reference

#include <spellpopup.h>

Inheritance diagram for SpellPopup:
Popup Container MouseListener WidgetListener BasicContainer2 BasicContainer Widget WidgetDeathListener Widget2

Public Member Functions

 SpellPopup ()
 
 ~SpellPopup ()
 
void postInit ()
 
void setItem (const TextCommand *const spell)
 
void view (const int x, const int y)
 
void mouseMoved (MouseEvent &event)
 
- Public Member Functions inherited from Popup
 Popup (const std::string &name, std::string skin)
 
 ~Popup ()
 
void draw (Graphics *const graphics)
 
void safeDraw (Graphics *const graphics)
 
void setContentSize (int width, int height)
 
void setLocationRelativeTo (const Widget *const widget)
 
void mouseMoved (MouseEvent &event)
 
void setMinWidth (const int width)
 
int getMinWidth () const
 
void setMinHeight (const int height)
 
int getMinHeight () const
 
void setMaxWidth (const int width)
 
int getMaxWidth () const
 
void setMaxHeight (const int height)
 
int getMaxHeight () const
 
int getPadding () const
 
void setPadding (int padding)
 
void setPopupName (const std::string &name)
 
const std::string & getPopupName () const
 
void scheduleDelete ()
 
Rect getChildrenArea ()
 
void position (const int x, const int y)
 
void hide ()
 
void widgetResized (const Event &event)
 
void widgetMoved (const Event &event)
 
bool isPopupVisible () const
 
void postInit ()
 
- 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)
 
- 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)
 
void focusNext ()
 
void focusPrevious ()
 
void logic ()
 
void setFocusHandler (FocusHandler *const focusHandler)
 
void setInternalFocusHandler (FocusHandler *const focusHandler)
 
WidgetgetWidgetAt (int x, int y)
 
void death (const Event &event)
 
WidgetfindFirstWidget (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
 
WidgetgetParent () 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 RectgetDimension () 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 ColorgetBaseColor () const
 
void setForegroundColor (const Color &color)
 
const ColorgetForegroundColor () const
 
void setBackgroundColor (const Color &color)
 
const ColorgetBackgroundColor () const
 
virtual void requestFocus ()
 
virtual void requestMoveToTop ()
 
virtual void requestMoveToBottom ()
 
FocusHandlergetFocusHandler ()
 
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)
 
FontgetFont () 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 FocusHandlergetInternalFocusHandler ()
 
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 ()
 
- Public Member Functions inherited from Widget2
virtual ~Widget2 ()
 
const ColorgetThemeColor (const ThemeColorIdT type, const unsigned int alpha) const A_INLINE
 
const ColorgetThemeCharColor (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)
 
WidgetgetWindow () const
 
virtual void setWindow (Widget *const window)
 
- Public Member Functions inherited from WidgetDeathListener
virtual ~WidgetDeathListener ()
 
- Public Member Functions inherited from MouseListener
virtual ~MouseListener ()
 
virtual void mouseEntered (MouseEvent &event)
 
virtual void mouseExited (MouseEvent &event)
 
virtual void mousePressed (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)
 
- Public Member Functions inherited from WidgetListener
virtual ~WidgetListener ()
 
virtual void widgetHidden (const Event &event)
 
virtual void widgetShown (const Event &event)
 

Private Attributes

LabelmItemName
 
LabelmItemComment
 

Additional Inherited Members

- Static Public Member Functions inherited from Popup
static void setWindowContainer (WindowContainer *const windowContainer)
 
- Static Public Member Functions inherited from Widget
static void setGlobalFont (Font *const font)
 
static FontgetGloablFont ()
 
static void cleanGlobalFont ()
 
static bool widgetExists (const Widget *const widget)
 
static void distributeWindowResizeEvent ()
 
static WidgetcallPostInit (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 Member Functions inherited from BasicContainer
virtual void drawChildren (Graphics *const graphics)
 
virtual void safeDrawChildren (Graphics *const graphics)
 
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 MouseListener
 MouseListener ()
 
- Protected Member Functions inherited from WidgetListener
 WidgetListener ()
 
- Protected Attributes inherited from Popup
int mPadding
 
SkinmSkin
 
- 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
 
FocusHandlermFocusHandler
 
FocusHandlermInternalFocusHandler
 
WidgetmParent
 
FontmCurrentFont
 
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
 
WidgetmWindow
 
Color mForegroundColor2
 
- Static Protected Attributes inherited from Widget
static FontmGlobalFont = 0
 

Detailed Description

A popup that displays information about an item.

Definition at line 35 of file spellpopup.h.

Constructor & Destructor Documentation

◆ SpellPopup()

SpellPopup::SpellPopup ( )

Constructor. Initializes the item popup.

Definition at line 36 of file spellpopup.cpp.

36  :
37  Popup("SpellPopup", "spellpopup.xml"),
38  mItemName(new Label(this)),
39  mItemComment(new Label(this))
40 {
43  getThemeColor(ThemeColorId::POPUP, 255U),
44  getThemeColor(ThemeColorId::POPUP_OUTLINE, 255U));
46  getThemeColor(ThemeColorId::POPUP, 255U),
47  getThemeColor(ThemeColorId::POPUP_OUTLINE, 255U));
48 }
Definition: label.h:91
void setForegroundColorAll(const Color &color1, const Color &color2)
Definition: label.cpp:217
Popup(const std::string &name, std::string skin)
Definition: popup.cpp:40
Label * mItemName
Definition: spellpopup.h:65
Label * mItemComment
Definition: spellpopup.h:66
const Color & getThemeColor(const ThemeColorIdT type, const unsigned int alpha) const A_INLINE
Definition: widget2.h:45
void setFont(Font *const font)
Definition: widget.cpp:349
Font * boldFont
Definition: gui.cpp:112

References boldFont, Widget2::getThemeColor(), mItemComment, mItemName, Widget::setFont(), and Label::setForegroundColorAll().

◆ ~SpellPopup()

SpellPopup::~SpellPopup ( )

Destructor. Cleans up the item popup on deletion.

Definition at line 59 of file spellpopup.cpp.

60 {
61 }

Member Function Documentation

◆ mouseMoved()

void SpellPopup::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
eventDescribes the event.

Reimplemented from MouseListener.

Definition at line 119 of file spellpopup.cpp.

120 {
121  Popup::mouseMoved(event);
122 
123  // When the mouse moved on top of the popup, hide it
125 }
void mouseMoved(MouseEvent &event)
Definition: popup.cpp:255
void setVisible(Visible visible)
Definition: widget.cpp:225
const bool Visible_false
Definition: visible.h:30

References Popup::mouseMoved(), Widget::setVisible(), and Visible_false.

◆ postInit()

void SpellPopup::postInit ( )
virtual

Reimplemented from Widget.

Definition at line 50 of file spellpopup.cpp.

51 {
53  add(mItemName);
55 
56  addMouseListener(this);
57 }
virtual void add(Widget *const widget)
void postInit()
Definition: popup.h:177
void addMouseListener(MouseListener *const mouseListener)
Definition: widget.cpp:292

References BasicContainer2::add(), Widget::addMouseListener(), mItemComment, mItemName, and Popup::postInit().

◆ setItem()

void SpellPopup::setItem ( const TextCommand *const  spell)

Sets the info to be displayed given a particular item.

Definition at line 63 of file spellpopup.cpp.

64 {
65  if (spell != nullptr)
66  {
67  mItemName->setCaption(spell->getName());
69  }
70  else
71  {
72  mItemName->setCaption("?");
74  }
75 
78  int minWidth = mItemName->getWidth();
79  if (mItemComment->getWidth() > minWidth)
80  minWidth = mItemComment->getWidth();
81 
82  mItemName->setPosition(0, 0);
83  const int fontHeight = mItemName->getHeight();
84  mItemComment->setPosition(0, fontHeight);
85  if (!mItemComment->getCaption().empty())
86  setContentSize(minWidth, 2 * fontHeight);
87  else
88  setContentSize(minWidth, fontHeight);
89 }
void adjustSize()
Definition: label.cpp:200
const std::string & getCaption() const
Definition: label.h:133
void setCaption(const std::string &caption)
Definition: label.cpp:264
void setContentSize(int width, int height)
Definition: popup.cpp:155
std::string getName() const
Definition: textcommand.h:82
std::string getComment() const
Definition: textcommand.h:88
void setPosition(const int x, const int y)
Definition: widget.cpp:161
int getHeight() const
Definition: widget.h:240
int getWidth() const
Definition: widget.h:221

References Label::adjustSize(), Label::getCaption(), TextCommand::getComment(), Widget::getHeight(), TextCommand::getName(), Widget::getWidth(), mItemComment, mItemName, Label::setCaption(), Popup::setContentSize(), and Widget::setPosition().

Referenced by ItemShortcutContainer::mouseMoved(), and SpellShortcutContainer::mouseMoved().

◆ view()

void SpellPopup::view ( const int  x,
const int  y 
)

Sets the location to display the item popup.

Definition at line 91 of file spellpopup.cpp.

92 {
93  const int distance = 20;
94 
95  int posX = std::max(0, x - getWidth() / 2);
96  int posY = y + distance;
97 
98  const Rect &rect = mDimension;
99  const int w = rect.width;
100  const int h = rect.height;
101  if (posX + w > mainGraphics->mWidth)
102  {
103  if (mainGraphics->mWidth > w)
104  posX = mainGraphics->mWidth - w;
105  else
106  posX = 0;
107  }
108  if (posY + h > mainGraphics->mHeight)
109  {
110  if (y > h + distance)
111  posY = y - h - distance;
112  }
113 
114  setPosition(posX, posY);
117 }
int mWidth
Definition: graphics.h:484
int mHeight
Definition: graphics.h:485
Definition: rect.h:74
int width
Definition: rect.h:219
int height
Definition: rect.h:224
virtual void requestMoveToTop()
Definition: widget.cpp:213
Rect mDimension
Definition: widget.h:1101
Graphics * mainGraphics
Definition: graphics.cpp:109
const bool Visible_true
Definition: visible.h:30

References Widget::getWidth(), Rect::height, mainGraphics, Widget::mDimension, Graphics::mHeight, Graphics::mWidth, Widget::requestMoveToTop(), Widget::setPosition(), Widget::setVisible(), Visible_true, Rect::width, x, and y.

Referenced by ItemShortcutContainer::mouseMoved(), and SpellShortcutContainer::mouseMoved().

Field Documentation

◆ mItemComment

Label* SpellPopup::mItemComment
private

Definition at line 66 of file spellpopup.h.

Referenced by postInit(), setItem(), and SpellPopup().

◆ mItemName

Label* SpellPopup::mItemName
private

Definition at line 65 of file spellpopup.h.

Referenced by postInit(), setItem(), and SpellPopup().


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