ManaPlus
Public Member Functions | Private Attributes
CutInWindow Class Reference

#include <cutinwindow.h>

Inheritance diagram for CutInWindow:
Window BasicContainer2 MouseListener WidgetListener BasicContainer Widget WidgetDeathListener Widget2

Public Member Functions

 CutInWindow ()
 
 ~CutInWindow ()
 
void draw (Graphics *const graphics)
 
void safeDraw (Graphics *const graphics)
 
void draw2 (Graphics *const graphics)
 
void show (const std::string &name, const CutInT cutin)
 
void hide ()
 
void logic ()
 
- Public Member Functions inherited from Window
 Window (const std::string &caption="Window", const Modal modal=Modal_false, Window *const parent=0, std::string skin="")
 
virtual ~Window ()
 
void setContentSize (int width, int height)
 
void setLocationRelativeTo (const Widget *const widget)
 
void setLocationHorisontallyRelativeTo (const Widget *const widget)
 
void setLocationRelativeTo (const ImagePosition::Type &position, int offsetX=0, int offsetY=0)
 
void setResizable (const bool resize)
 
void redraw ()
 
void widgetResized (const Event &event)
 
void widgetMoved (const Event &event)
 
void widgetHidden (const Event &event)
 
void setCloseButton (const bool flag)
 
bool getCloseButton () const
 
void setAllowClose (const bool b)
 
bool getAlowClose () const
 
bool isResizable () const
 
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
 
void setShowTitle (bool flag)
 
void setStickyButton (const bool flag)
 
void setSticky (const bool sticky)
 
bool isSticky () const
 
void setStickyButtonLock (const bool sticky)
 
bool isStickyButtonLock () const
 
virtual void setVisible (Visible visible)
 
void setVisible (const Visible visible, const bool forceSticky)
 
bool isDefaultVisible () const
 
void setDefaultVisible (const bool save)
 
bool willSaveVisible () const
 
void setSaveVisible (const bool save)
 
void postInit ()
 
WindowgetParentWindow () const
 
virtual void scheduleDelete ()
 
void mousePressed (MouseEvent &event)
 
void mouseDragged (MouseEvent &event)
 
void mouseMoved (MouseEvent &event)
 
void mouseReleased (MouseEvent &event)
 
void mouseExited (MouseEvent &event)
 
void mouseEntered (MouseEvent &event)
 
void updateResizeHandler (MouseEvent &event)
 
void setWindowName (const std::string &name)
 
const std::string & getWindowName () const
 
void loadWindowState ()
 
void saveWindowState ()
 
void setDefaultSize (const int defaultX, const int defaultY, int defaultWidth, int defaultHeight)
 
void setDefaultSize ()
 
void setDefaultSize (const int defaultWidth, const int defaultHeight, const ImagePosition::Type &position, const int offsetx=0, const int offsetY=0)
 
virtual void resetToDefaultSize ()
 
void adjustPositionAfterResize (const int oldScreenWidth, const int oldScreenHeight)
 
LayoutgetLayout ()
 
void clearLayout ()
 
void reflowLayout (int w=0, int h=0)
 
LayoutCellplace (const int x, const int y, Widget *const wg, const int w=1, const int h=1)
 
ContainerPlacer getPlacer (const int x, const int y)
 
void center ()
 
void centerHorisontally ()
 
virtual void close ()
 
void setModal (const Modal modal)
 
Rect getWindowArea () const
 
bool isResizeAllowed (const MouseEvent &event) const
 
void setCaptionFont (Font *font)
 
void enableVisibleSound (bool b)
 
bool isWindowVisible () const
 
void setPadding (int padding)
 
int getPadding () const
 
void setTitleBarHeight (unsigned int height)
 
unsigned int getTitleBarHeight () const
 
void setCaption (const std::string &caption)
 
const std::string & getCaption () const
 
void setAlignment (Graphics::Alignment alignment)
 
Graphics::Alignment getAlignment () const
 
void setMovable (Move movable)
 
bool isMovable () const
 
Rect getChildrenArea ()
 
virtual void resizeToContent ()
 
- Public Member Functions inherited from BasicContainer2
 BasicContainer2 (const Widget2 *const widget)
 
virtual ~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)
 
virtual ~BasicContainer ()
 
void showWidgetPart (Widget *const widget, const Rect &area)
 
void moveToTop (Widget *const widget)
 
void moveToBottom (Widget *const widget)
 
void focusNext ()
 
void focusPrevious ()
 
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)
 
virtual ~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=255U) 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 mouseClicked (MouseEvent &event)
 
virtual void mouseWheelMovedUp (MouseEvent &event)
 
virtual void mouseWheelMovedDown (MouseEvent &event)
 
- Public Member Functions inherited from WidgetListener
virtual ~WidgetListener ()
 
virtual void widgetShown (const Event &event)
 

Private Attributes

AnimatedSpritemImage
 
int mOldTitleBarHeight
 

Additional Inherited Members

- Static Public Member Functions inherited from Window
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 Window
bool canMove () const
 
int getOption (const std::string &name, const int def=0) const
 
bool getOptionBool (const std::string &name, const bool def=false) const
 
void setTitlePadding (const int p)
 
int getTitlePadding () const
 
- 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 Window
std::string mCaption
 
Graphics::Alignment mAlignment
 
int mPadding
 
unsigned int mTitleBarHeight
 
Move mMovable
 
int mDragOffsetX
 
int mDragOffsetY
 
bool mMoved
 
SkinmSkin
 
int mDefaultX
 
int mDefaultY
 
int mDefaultWidth
 
int mDefaultHeight
 
int mCaptionOffsetX
 
int mCaptionOffsetY
 
bool mShowTitle
 
bool mLastRedraw
 
- 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

Definition at line 32 of file cutinwindow.h.

Constructor & Destructor Documentation

◆ CutInWindow()

CutInWindow::CutInWindow ( )

Definition at line 38 of file cutinwindow.cpp.

References Window::enableVisibleSound(), Window::setDefaultVisible(), Window::setResizable(), Window::setSaveVisible(), Window::setShowTitle(), Window::setVisible(), Window::setWindowName(), and Visible_false.

38  :
39  Window("", Modal_false, nullptr, "cutin.xml"),
40  mImage(nullptr),
42 {
43  setWindowName("CutIn");
44 
45  setShowTitle(false);
46  setResizable(false);
47  setDefaultVisible(false);
48  setSaveVisible(false);
50  enableVisibleSound(false);
51 }
void setDefaultVisible(const bool save)
Definition: window.h:286
int mOldTitleBarHeight
Definition: cutinwindow.h:56
void setShowTitle(bool flag)
Definition: window.h:233
const bool Visible_false
Definition: visible.h:29
AnimatedSprite * mImage
Definition: cutinwindow.h:55
void enableVisibleSound(bool b)
Definition: window.h:473
void setSaveVisible(const bool save)
Definition: window.h:298
virtual void setVisible(Visible visible)
Definition: window.cpp:766
void setResizable(const bool resize)
Definition: window.cpp:615
Window(const std::string &caption="Window", const Modal modal=Modal_false, Window *const parent=0, std::string skin="")
Definition: window.cpp:108
unsigned int mTitleBarHeight
Definition: window.h:615
void setWindowName(const std::string &name)
Definition: window.h:353

◆ ~CutInWindow()

CutInWindow::~CutInWindow ( )

Definition at line 53 of file cutinwindow.cpp.

References delete2, and mImage.

54 {
55  delete2(mImage);
56 }
#define delete2(var)
Definition: delete2.h:24
AnimatedSprite * mImage
Definition: cutinwindow.h:55

Member Function Documentation

◆ draw()

void CutInWindow::draw ( Graphics *const  graphics)
virtual

Draws the window.

Reimplemented from Window.

Definition at line 58 of file cutinwindow.cpp.

References Window::draw(), and draw2().

59 {
60  Window::draw(graphics);
61  draw2(graphics);
62 }
void draw(Graphics *const graphics)
Definition: window.cpp:303
void draw2(Graphics *const graphics)
Definition: cutinwindow.cpp:70

◆ draw2()

void CutInWindow::draw2 ( Graphics *const  graphics)

Definition at line 70 of file cutinwindow.cpp.

References AnimatedSprite::drawRaw(), mImage, Window::mPadding, and Window::mTitleBarHeight.

Referenced by draw(), and safeDraw().

71 {
72  if (mImage != nullptr)
74 }
int mPadding
Definition: window.h:610
void drawRaw(Graphics *const graphics, const int posX, const int posY) const
AnimatedSprite * mImage
Definition: cutinwindow.h:55
unsigned int mTitleBarHeight
Definition: window.h:615

◆ hide()

void CutInWindow::hide ( )

Definition at line 140 of file cutinwindow.cpp.

References delete2, mImage, Window::setVisible(), and Visible_false.

Referenced by NpcDialog::action().

141 {
142  delete2(mImage);
144 }
#define delete2(var)
Definition: delete2.h:24
const bool Visible_false
Definition: visible.h:29
AnimatedSprite * mImage
Definition: cutinwindow.h:55
virtual void setVisible(Visible visible)
Definition: window.cpp:766

◆ logic()

void CutInWindow::logic ( )
virtual

Called for all widgets in the gui each time Gui::logic is called. You can do logic stuff here like playing an animation.

See also
Gui::logic

Reimplemented from BasicContainer.

Definition at line 146 of file cutinwindow.cpp.

References MILLISECONDS_IN_A_TICK, mImage, tick_time, ServerCommandType::time, and AnimatedSprite::update().

147 {
148  if (mImage != nullptr)
149  {
150  const int time = tick_time * MILLISECONDS_IN_A_TICK;
151  mImage->update(time);
152  }
153 }
volatile int tick_time
Definition: timer.cpp:52
static const int MILLISECONDS_IN_A_TICK
Definition: timer.h:29
AnimatedSprite * mImage
Definition: cutinwindow.h:55
bool update(const int time)

◆ safeDraw()

void CutInWindow::safeDraw ( Graphics *const  graphics)
virtual

Reimplemented from Window.

Definition at line 64 of file cutinwindow.cpp.

References draw2(), and Window::safeDraw().

65 {
66  Window::safeDraw(graphics);
67  draw2(graphics);
68 }
void draw2(Graphics *const graphics)
Definition: cutinwindow.cpp:70
void safeDraw(Graphics *const graphics)
Definition: window.cpp:415

◆ show()

void CutInWindow::show ( const std::string &  name,
const CutInT  cutin 
)

Definition at line 76 of file cutinwindow.cpp.

References CutIn::BottomCenter, CutIn::BottomLeft, CutIn::BottomRight, delete2, AnimatedSprite::getHeight(), Configuration::getStringValue(), AnimatedSprite::getWidth(), AnimatedSprite::load(), mainGraphics, Graphics::mHeight, mImage, mOldTitleBarHeight, CutIn::Movable, CutIn::MovableClose, Window::mPadding, Window::mTitleBarHeight, Graphics::mWidth, pathJoin(), paths, Widget::requestMoveToTop(), Window::setCloseButton(), Widget::setPosition(), Window::setShowTitle(), Widget::setSize(), Window::setVisible(), AnimatedSprite::update(), Visible_false, Visible_true, x, and y.

Referenced by EAthena::NpcRecv::processNpcCutin().

78 {
79  delete2(mImage);
80  if (name.empty())
81  {
83  }
84  else
85  {
87  pathJoin(paths.getStringValue("cutInsDir"),
88  name).append(
89  ".xml"));
90  if (mImage != nullptr)
91  {
92  mImage->update(1);
93  const bool showTitle = (cutin == CutIn::MovableClose);
94  if (showTitle)
96  else
98  const int width = mImage->getWidth() + 2 * mPadding;
99  const int height = mImage->getHeight() + mTitleBarHeight
100  + mPadding;
101 
102  const int screenWidth = mainGraphics->mWidth;
103  const int screenHeight = mainGraphics->mHeight;
104 
105  if (width * 2 > screenWidth ||
106  height * 2 > screenHeight)
107  {
108  return;
109  }
110  const int padding = 100;
111  int x = 0;
112  const int y = screenHeight - height - padding;
113  switch (cutin)
114  {
115  case CutIn::BottomRight:
116  x = screenWidth - width - padding;
117  break;
118  case CutIn::BottomCenter:
119  case CutIn::Movable:
120  case CutIn::MovableClose:
121  x = (screenWidth - width) / 2;
122  break;
123  case CutIn::BottomLeft:
124  default:
125  x = padding;
126  break;
127  }
128  setCloseButton(false);
130  setPosition(x, y);
131  setCloseButton(showTitle);
132  setShowTitle(showTitle);
133  setSize(width, height);
136  }
137  }
138 }
void setSize(const int width, const int height)
Definition: widget.cpp:366
std::string getStringValue(const std::string &key) const
int mPadding
Definition: window.h:610
const bool Visible_true
Definition: visible.h:29
int mOldTitleBarHeight
Definition: cutinwindow.h:56
std::string pathJoin(std::string str1, const std::string &str2)
virtual void requestMoveToTop()
Definition: widget.cpp:212
int mWidth
Definition: graphics.h:483
void setShowTitle(bool flag)
Definition: window.h:233
#define delete2(var)
Definition: delete2.h:24
static AnimatedSprite * load(const std::string &filename, const int variant=0)
int getHeight() const
const bool Visible_false
Definition: visible.h:29
Graphics * mainGraphics
Definition: graphics.cpp:108
void setPosition(const int x, const int y)
Definition: widget.cpp:160
void setCloseButton(const bool flag)
Definition: window.cpp:737
int mHeight
Definition: graphics.h:484
AnimatedSprite * mImage
Definition: cutinwindow.h:55
Configuration paths
virtual void setVisible(Visible visible)
Definition: window.cpp:766
int getWidth() const
bool update(const int time)
unsigned int mTitleBarHeight
Definition: window.h:615

Field Documentation

◆ mImage

AnimatedSprite* CutInWindow::mImage
private

Definition at line 55 of file cutinwindow.h.

Referenced by draw2(), hide(), logic(), show(), and ~CutInWindow().

◆ mOldTitleBarHeight

int CutInWindow::mOldTitleBarHeight
private

Definition at line 56 of file cutinwindow.h.

Referenced by show().


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