ManaPlus
Public Member Functions | Private Attributes
SkillPopup Class Reference

#include <skillpopup.h>

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

Public Member Functions

 SkillPopup ()
 
 ~SkillPopup ()
 
void postInit ()
 
void show (const SkillInfo *const skill, const int level, const CastTypeT type, const int offsetX, const int offsetY)
 
void mouseMoved (MouseEvent &event)
 
void reset ()
 
- 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

LabelmSkillName
 
TextBoxmSkillDesc
 
TextBoxmSkillEffect
 
TextBoxmSkillLevel
 
TextBoxmSkillCastType
 
CastTypeT mCastType
 
unsigned int mLastId
 
int mLastLevel
 
int mOffsetX
 
int mOffsetY
 

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 40 of file skillpopup.h.

Constructor & Destructor Documentation

◆ SkillPopup()

SkillPopup::SkillPopup ( )

Constructor. Initializes the skill popup.

Definition at line 44 of file skillpopup.cpp.

44  :
45  Popup("SkillPopup", "skillpopup.xml"),
46  mSkillName(new Label(this)),
47  mSkillDesc(new TextBox(this)),
48  mSkillEffect(new TextBox(this)),
49  mSkillLevel(new TextBox(this)),
50  mSkillCastType(new TextBox(this)),
52  mLastId(0U),
53  mLastLevel(-1),
54  mOffsetX(0),
55  mOffsetY(0)
56 {
58  mSkillName->setPosition(0, 0);
60  getThemeColor(ThemeColorId::POPUP, 255U),
61  getThemeColor(ThemeColorId::POPUP_OUTLINE, 255U));
62 
63  const int fontHeight = getFont()->getHeight();
64 
65  mSkillDesc->setEditable(false);
66  mSkillDesc->setPosition(0, fontHeight);
68  getThemeColor(ThemeColorId::POPUP, 255U),
69  getThemeColor(ThemeColorId::POPUP_OUTLINE, 255U));
70 
71  mSkillEffect->setEditable(false);
72  mSkillEffect->setPosition(0, 2 * fontHeight);
74  getThemeColor(ThemeColorId::POPUP, 255U),
75  getThemeColor(ThemeColorId::POPUP_OUTLINE, 255U));
76 
77  mSkillLevel->setEditable(false);
78  mSkillLevel->setPosition(0, 3 * fontHeight);
80  getThemeColor(ThemeColorId::POPUP, 255U),
81  getThemeColor(ThemeColorId::POPUP_OUTLINE, 255U));
82 
84  mSkillCastType->setPosition(0, 4 * fontHeight);
86  getThemeColor(ThemeColorId::POPUP, 255U),
87  getThemeColor(ThemeColorId::POPUP_OUTLINE, 255U));
88 }
int getHeight() const
Definition: font.cpp:362
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 * mSkillName
Definition: skillpopup.h:71
TextBox * mSkillLevel
Definition: skillpopup.h:74
TextBox * mSkillDesc
Definition: skillpopup.h:72
TextBox * mSkillCastType
Definition: skillpopup.h:75
CastTypeT mCastType
Definition: skillpopup.h:76
int mOffsetX
Definition: skillpopup.h:79
unsigned int mLastId
Definition: skillpopup.h:77
int mLastLevel
Definition: skillpopup.h:78
TextBox * mSkillEffect
Definition: skillpopup.h:73
int mOffsetY
Definition: skillpopup.h:80
void setEditable(const bool editable)
Definition: textbox.cpp:650
void setForegroundColorAll(const Color &color1, const Color &color2)
Definition: textbox.cpp:488
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 * getFont() const
Definition: widget.cpp:331
void setPosition(const int x, const int y)
Definition: widget.cpp:161
Font * boldFont
Definition: gui.cpp:112
@ Default
Definition: casttype.h:29

References boldFont, Widget::getFont(), Font::getHeight(), Widget2::getThemeColor(), mSkillCastType, mSkillDesc, mSkillEffect, mSkillLevel, mSkillName, TextBox::setEditable(), Widget::setFont(), Label::setForegroundColorAll(), TextBox::setForegroundColorAll(), and Widget::setPosition().

◆ ~SkillPopup()

SkillPopup::~SkillPopup ( )

Destructor. Cleans up the skill popup on deletion.

Definition at line 102 of file skillpopup.cpp.

103 {
104 }

Member Function Documentation

◆ mouseMoved()

void SkillPopup::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 240 of file skillpopup.cpp.

241 {
242  Popup::mouseMoved(event);
243 
244  // When the mouse moved on top of the popup, hide it
246  mLastId = 0;
247 }
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 mLastId, Popup::mouseMoved(), Widget::setVisible(), and Visible_false.

◆ postInit()

void SkillPopup::postInit ( )
virtual

Reimplemented from Widget.

Definition at line 90 of file skillpopup.cpp.

91 {
93  add(mSkillName);
94  add(mSkillDesc);
98 
99  addMouseListener(this);
100 }
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(), mSkillCastType, mSkillDesc, mSkillEffect, mSkillLevel, mSkillName, and Popup::postInit().

◆ reset()

void SkillPopup::reset ( )

Definition at line 249 of file skillpopup.cpp.

250 {
251  mLastId = 0;
252  mLastLevel = 0;
254  mOffsetX = 0;
255  mOffsetY = 0;
256 }

References CastType::Default, mCastType, mLastId, mLastLevel, mOffsetX, and mOffsetY.

Referenced by SkillDialog::update().

◆ show()

void SkillPopup::show ( const SkillInfo *const  skill,
const int  level,
const CastTypeT  type,
const int  offsetX,
const int  offsetY 
)

Sets the info to be displayed given a particular item.

Definition at line 106 of file skillpopup.cpp.

111 {
112  if ((skill == nullptr) ||
113  (skill->data == nullptr) ||
114  (skill->id == mLastId &&
115  level == mLastLevel &&
116  castType == mCastType &&
117  offsetX == mOffsetX &&
118  offsetY == mOffsetY))
119  {
120  return;
121  }
122 
123  mLastId = skill->id;
124  mLastLevel = level;
125  mCastType = castType;
126  mOffsetX = offsetX;
127  mOffsetY = offsetY;
128 
129  mSkillName->setCaption(skill->data->dispName);
131  mSkillName->setPosition(0, 0);
132 
133  std::string description = skill->data->description;
134  std::string effect = skill->skillEffect;
135  if (description.empty())
136  {
137  description = effect;
138  effect.clear();
139  }
140  mSkillDesc->setTextWrapped(description, 196);
141  mSkillEffect->setTextWrapped(effect, 196);
142  if (level != 0)
143  {
145  // TRANSLATORS: skill level
146  _("Level: %d / %d"), level, skill->level),
147  196);
148  }
149  else
150  {
151  if (skill->level != 0)
152  {
154  // TRANSLATORS: skill level
155  _("Level: %d"), skill->level),
156  196);
157  }
158  else
159  {
161  // TRANSLATORS: skill level for tmw fake skills
162  _("Level: Unknown"),
163  196);
164  }
165  }
166  std::string castStr;
167  switch (castType)
168  {
169  case CastType::Default:
170  default:
171  // TRANSLATORS: skill cast type
172  castStr = _("Default");
173  break;
174  case CastType::Target:
175  // TRANSLATORS: skill cast type
176  castStr = _("Target");
177  break;
178  case CastType::Position:
179  // TRANSLATORS: skill cast type
180  castStr = _("Mouse position");
181  break;
182  case CastType::Self:
183  // TRANSLATORS: skill cast type
184  castStr = _("Self position");
185  break;
186  }
187  if (offsetX != 0 ||
188  offsetY != 0)
189  {
190  castStr.append(strprintf(" (%+d,%+d)",
191  offsetX,
192  offsetY));
193  }
195  // TRANSLATORS: skill cast type
196  _("Cast type: %s"),
197  castStr.c_str()), 196);
198 
199  int minWidth = mSkillName->getWidth();
200 
201  if (mSkillName->getWidth() > minWidth)
202  minWidth = mSkillName->getWidth();
203  if (mSkillDesc->getMinWidth() > minWidth)
204  minWidth = mSkillDesc->getMinWidth();
205  if (mSkillEffect->getMinWidth() > minWidth)
206  minWidth = mSkillEffect->getMinWidth();
207  if (mSkillLevel->getMinWidth() > minWidth)
208  minWidth = mSkillLevel->getMinWidth();
209  if (mSkillCastType->getMinWidth() > minWidth)
210  minWidth = mSkillCastType->getMinWidth();
211 
212  const int numRowsDesc = mSkillDesc->getNumberOfRows();
213  const int numRowsLevel = mSkillLevel->getNumberOfRows();
214  const int numRowsCast = mSkillCastType->getNumberOfRows();
215  const int height = getFont()->getHeight();
216 
217  if (skill->skillEffect.empty())
218  {
219  setContentSize(minWidth,
220  (numRowsDesc + numRowsLevel + numRowsCast + 1) * height);
221  mSkillLevel->setPosition(0, (numRowsDesc + 1) * height);
222  mSkillCastType->setPosition(0, (numRowsDesc + 2) * height);
223  }
224  else
225  {
226  const int numRowsEffect = mSkillEffect->getNumberOfRows();
227  setContentSize(minWidth,
228  (numRowsDesc + numRowsLevel + numRowsEffect + numRowsCast + 1) *
229  height);
230  mSkillEffect->setPosition(0, (numRowsDesc + 1) * height);
232  (numRowsDesc + numRowsEffect + 1) * height);
234  (numRowsDesc + numRowsEffect + 2) * height);
235  }
236 
237  mSkillDesc->setPosition(0, 1 * height);
238 }
void adjustSize()
Definition: label.cpp:200
void setCaption(const std::string &caption)
Definition: label.cpp:264
void setContentSize(int width, int height)
Definition: popup.cpp:155
unsigned int getNumberOfRows() const
Definition: textbox.h:162
int getMinWidth() const
Definition: textbox.h:108
void setTextWrapped(const std::string &text, const int minDimension)
Definition: textbox.cpp:109
int getWidth() const
Definition: widget.h:221
#define _(s)
Definition: gettext.h:35
bool skill(InputEvent &event)
Definition: commands.cpp:97
@ Position
Definition: casttype.h:31
@ Target
Definition: casttype.h:30
@ Self
Definition: casttype.h:32
std::string strprintf(const char *const format,...)

References _, Label::adjustSize(), CastType::Default, Widget::getFont(), Font::getHeight(), TextBox::getMinWidth(), TextBox::getNumberOfRows(), Widget::getWidth(), mCastType, mLastId, mLastLevel, mOffsetX, mOffsetY, mSkillCastType, mSkillDesc, mSkillEffect, mSkillLevel, mSkillName, CastType::Position, CastType::Self, Label::setCaption(), Popup::setContentSize(), Widget::setPosition(), TextBox::setTextWrapped(), Actions::skill(), strprintf(), and CastType::Target.

Referenced by ItemShortcutContainer::mouseMoved(), SkillListBox::mouseMoved(), and SkillRectangleListBox::mouseMoved().

Field Documentation

◆ mCastType

CastTypeT SkillPopup::mCastType
private

Definition at line 76 of file skillpopup.h.

Referenced by reset(), and show().

◆ mLastId

unsigned int SkillPopup::mLastId
private

Definition at line 77 of file skillpopup.h.

Referenced by mouseMoved(), reset(), and show().

◆ mLastLevel

int SkillPopup::mLastLevel
private

Definition at line 78 of file skillpopup.h.

Referenced by reset(), and show().

◆ mOffsetX

int SkillPopup::mOffsetX
private

Definition at line 79 of file skillpopup.h.

Referenced by reset(), and show().

◆ mOffsetY

int SkillPopup::mOffsetY
private

Definition at line 80 of file skillpopup.h.

Referenced by reset(), and show().

◆ mSkillCastType

TextBox* SkillPopup::mSkillCastType
private

Definition at line 75 of file skillpopup.h.

Referenced by postInit(), show(), and SkillPopup().

◆ mSkillDesc

TextBox* SkillPopup::mSkillDesc
private

Definition at line 72 of file skillpopup.h.

Referenced by postInit(), show(), and SkillPopup().

◆ mSkillEffect

TextBox* SkillPopup::mSkillEffect
private

Definition at line 73 of file skillpopup.h.

Referenced by postInit(), show(), and SkillPopup().

◆ mSkillLevel

TextBox* SkillPopup::mSkillLevel
private

Definition at line 74 of file skillpopup.h.

Referenced by postInit(), show(), and SkillPopup().

◆ mSkillName

Label* SkillPopup::mSkillName
private

Definition at line 71 of file skillpopup.h.

Referenced by postInit(), show(), and SkillPopup().


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