#include <window.h>

Inheritance diagram for Window:

Public Member Functions
	Window (const std::string &caption, const Modal modal, Window *const parent, std::string skin)

	~Window ()

void	draw (Graphics *const graphics)

void	safeDraw (Graphics *const graphics)

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, int offsetY)

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 ()

Window *	getParentWindow () 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, const int offsetY)

virtual void	resetToDefaultSize ()

void	adjustPositionAfterResize (const int oldScreenWidth, const int oldScreenHeight)

Layout &	getLayout ()

void	clearLayout ()

void	reflowLayout (int w, int h)

LayoutCell &	place (const int x, const int y, Widget *const wg, const int w, const int h)

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)

	~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)

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 ()

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 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)

Static Public Member Functions
static void	setWindowContainer (WindowContainer *const windowContainer)

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)

Protected Member Functions
bool	canMove () const

int	getOption (const std::string &name, const int def) const

bool	getOptionBool (const std::string &name, const bool def) 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
std::string	mCaption

Graphics::Alignment	mAlignment

int	mPadding

unsigned int	mTitleBarHeight

Move	mMovable

int	mDragOffsetX

int	mDragOffsetY

bool	mMoved

Skin *	mSkin

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

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

Private Types
enum	ResizeHandles { TOP = 0x01 , RIGHT = 0x02 , BOTTOM = 0x04 , LEFT = 0x08 , CLOSE = 0x10 }

Private Member Functions
void	ensureOnScreen ()

void	adjustSizeToScreen ()

int	getResizeHandles (const MouseEvent &event)

Private Attributes
Image *	mGrip

Window *	mParentWindow

Layout *	mLayout

Rect	mCloseRect

Rect	mStickyRect

Rect	mGripRect

TextChunk	mTextChunk

std::string	mWindowName

int	mMinWinWidth

int	mMinWinHeight

int	mMaxWinWidth

int	mMaxWinHeight

ImageCollection *	mVertexes

Graphics::Alignment	mCaptionAlign

int	mTitlePadding

int	mGripPadding

int	mResizeHandles

int	mOldResizeHandles

int	mClosePadding

int	mStickySpacing

int	mStickyPadding

Font *	mCaptionFont

Modal	mModal

bool	mCloseWindowButton

bool	mDefaultVisible

bool	mSaveVisible

bool	mStickyButton

bool	mSticky

bool	mStickyButtonLock

bool	mPlayVisibleSound

bool	mInit

bool	mTextChanged

bool	mAllowClose

Static Private Attributes
static int	mouseResize = 0

static int	windowInstances = 0

static const unsigned	resizeBorderWidth = 10

Additional Inherited Members
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

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

Detailed Description

A window. This window can be dragged around and has a title bar. Windows are invisible by default.

Definition at line 99 of file window.h.

Member Enumeration Documentation

◆ ResizeHandles

enum Window::ResizeHandles

private

Enumerator
TOP
RIGHT
BOTTOM
LEFT
CLOSE

Definition at line 660 of file window.h.

         {
             TOP    = 0x01,
             RIGHT  = 0x02,
             BOTTOM = 0x04,
             LEFT   = 0x08,
             CLOSE  = 0x10
         };

Constructor & Destructor Documentation

◆ Window()

Window::Window	(	const std::string &	caption,
		const Modal	modal,
		Window *const	parent,
		std::string	skin
	)

Constructor. Initializes the title to the given text and hooks itself into the window container.

Parameters

caption	The initial window title, "Window" by default.
modal	Block input to other windows.
parent	The parent window. This is the window standing above this one in the window hiearchy. When reordering, a window will never go below its parent window.
skin	The location where the window's skin XML can be found.

Definition at line 109 of file window.cpp.

                                :
     BasicContainer2(nullptr),
     MouseListener(),
     WidgetListener(),
     mCaption(caption),
     mAlignment(Graphics::CENTER),
     mPadding(2),
     mTitleBarHeight(16),
     mMovable(Move_true),
     mDragOffsetX(0),
     mDragOffsetY(0),
     mMoved(false),
     mSkin(nullptr),
     mDefaultX(0),
     mDefaultY(0),
     mDefaultWidth(0),
     mDefaultHeight(0),
     mCaptionOffsetX(7),
     mCaptionOffsetY(5),
     mShowTitle(true),
     mLastRedraw(true),
     mGrip(nullptr),
     mParentWindow(parent),
     mLayout(nullptr),
     mCloseRect(),
     mStickyRect(),
     mGripRect(),
     mTextChunk(),
     mWindowName("window"),
     mMinWinWidth(100),
     mMinWinHeight(40),
     mMaxWinWidth(mainGraphics->mWidth),
     mMaxWinHeight(mainGraphics->mHeight),
     mVertexes(new ImageCollection),
     mCaptionAlign(Graphics::LEFT),
     mTitlePadding(4),
     mGripPadding(2),
     mResizeHandles(-1),
     mOldResizeHandles(-1),
     mClosePadding(0),
     mStickySpacing(0),
     mStickyPadding(0),
     mCaptionFont(getFont()),
     mModal(modal),
     mCloseWindowButton(false),
     mDefaultVisible(false),
     mSaveVisible(false),
     mStickyButton(false),
     mSticky(false),
     mStickyButtonLock(false),
     mPlayVisibleSound(false),
     mInit(false),
     mTextChanged(true),
     mAllowClose(false)
 {
     logger->log("Window::Window(\"%s\")", caption.c_str());
  
     mWindow = this;
  
     windowInstances++;
  
 //    mFrameSize = 1;
     addMouseListener(this);
  
     setFrameSize(0);
     setPadding(3);
     setTitleBarHeight(20);
  
     if (skin.empty())
     {
         reportAlways("Default skin was used for window: %s",
             caption.c_str())
         skin = "window.xml";
     }
  
     int childPalette = 1;
     // Loads the skin
     if (theme != nullptr)
     {
         mSkin = theme->load(skin,
             "window.xml",
             true,
             Theme::getThemePath());
         if (mSkin != nullptr)
         {
             setPadding(mSkin->getPadding());
             if (getOptionBool("titlebarBold", false))
                 mCaptionFont = boldFont;
             mTitlePadding = mSkin->getTitlePadding();
             mGripPadding = getOption("resizePadding", 0);
             mCaptionOffsetX = getOption("captionoffsetx", 0);
             if (mCaptionOffsetX == 0)
                 mCaptionOffsetX = 7;
             mCaptionOffsetY = getOption("captionoffsety", 0);
             if (mCaptionOffsetY == 0)
                 mCaptionOffsetY = 5;
             mCaptionAlign = static_cast<Graphics::Alignment>(
                 getOption("captionalign", 0));
             if (mCaptionAlign < Graphics::LEFT
                 || mCaptionAlign > Graphics::RIGHT)
             {
                 mCaptionAlign = Graphics::LEFT;
             }
             setTitleBarHeight(CAST_U32(
                 getOption("titlebarHeight", 0)));
             if (mTitleBarHeight == 0U)
                 mTitleBarHeight = mCaptionFont->getHeight() + mPadding;
  
             mTitleBarHeight += getOption("titlebarHeightRelative", 0);
             setPalette(getOption("palette", 0));
             childPalette = getOption("childPalette", 0);
             mShowTitle = getOptionBool("showTitle", true);
             mClosePadding = getOption("closePadding", 0);
             mStickySpacing = getOption("stickySpacing", 0);
             mStickyPadding = getOption("stickyPadding", 0);
         }
     }
  
     // Add this window to the window container
     if (windowContainer != nullptr)
         windowContainer->add(this);
  
     if (mModal == Modal_true)
     {
         gui->setCursorType(Cursor::CURSOR_POINTER);
         requestModalFocus();
     }
  
     // Windows are invisible by default
     setVisible(Visible_false, false);
  
     addWidgetListener(this);
     mForegroundColor = getThemeColor(ThemeColorId::WINDOW, 255U);
     mForegroundColor2 = getThemeColor(ThemeColorId::WINDOW_OUTLINE, 255U);
     setPalette(childPalette);
 }

References BasicContainer2::add(), Widget::addMouseListener(), Widget::addWidgetListener(), boldFont, CAST_U32, Cursor::CURSOR_POINTER, Font::getHeight(), getOption(), getOptionBool(), Skin::getPadding(), Widget2::getThemeColor(), Theme::getThemePath(), Skin::getTitlePadding(), gui, Graphics::LEFT, Theme::load(), Logger::log(), logger, mCaptionAlign, mCaptionFont, mCaptionOffsetX, mCaptionOffsetY, mClosePadding, Widget::mForegroundColor, Widget2::mForegroundColor2, mGripPadding, mModal, Modal_true, mPadding, mShowTitle, mSkin, mStickyPadding, mStickySpacing, mTitleBarHeight, mTitlePadding, Widget2::mWindow, reportAlways, Widget::requestModalFocus(), Graphics::RIGHT, Gui::setCursorType(), Widget::setFrameSize(), setPadding(), Widget2::setPalette(), setTitleBarHeight(), setVisible(), theme, Visible_false, windowContainer, and windowInstances.

◆ ~Window()

Window::~Window ( )

Destructor. Deletes all the added widgets.

Definition at line 260 of file window.cpp.

 {
     logger->log("Window::~Window(\"%s\")", getCaption().c_str());
  
     if (gui != nullptr)
         gui->removeDragged(this);
  
 #ifndef DYECMD
     if (setupWindow != nullptr)
         setupWindow->unregisterWindowForReset(this);
 #endif  // DYECMD
  
     client->windowRemoved(this);
  
     saveWindowState();
  
     delete2(mLayout)
  
     while (!mWidgets.empty())
         delete mWidgets.front();
  
     mWidgets.clear();
  
     removeWidgetListener(this);
     delete2(mVertexes)
  
     windowInstances--;
  
     if (mSkin != nullptr)
     {
         if (theme != nullptr)
             theme->unload(mSkin);
         mSkin = nullptr;
     }
     if (mGrip != nullptr)
     {
         mGrip->decRef();
         mGrip = nullptr;
     }
     if (!mInit)
     {
         reportAlways("error: Window created without calling postInit(): %s",
             mWindowName.c_str())
     }
 }

References client, delete2, getCaption(), gui, Logger::log(), logger, mGrip, mInit, mLayout, mSkin, mVertexes, BasicContainer::mWidgets, mWindowName, Gui::removeDragged(), Widget::removeWidgetListener(), reportAlways, saveWindowState(), setupWindow, theme, Theme::unload(), SetupWindow::unregisterWindowForReset(), windowInstances, and Client::windowRemoved().

Member Function Documentation

◆ adjustPositionAfterResize()

void Window::adjustPositionAfterResize	(	const int	oldScreenWidth,
		const int	oldScreenHeight
	)

Adjusts the window position after the application window has been resized.

Definition at line 1266 of file window.cpp.

 {
     // If window was aligned to the right or bottom, keep it there
     const int rightMargin = oldScreenWidth - (mDimension.x + mDimension.width);
     const int bottomMargin = oldScreenHeight
         - (mDimension.y + mDimension.height);
     if (mDimension.x > 0 && mDimension.x > rightMargin)
         mDimension.x = mainGraphics->mWidth - rightMargin - mDimension.width;
     if (mDimension.y > 0 && mDimension.y > bottomMargin)
     {
         mDimension.y = mainGraphics->mHeight
             - bottomMargin - mDimension.height;
     }
  
     ensureOnScreen();
     adjustSizeToScreen();
 }

References adjustSizeToScreen(), ensureOnScreen(), Rect::height, mainGraphics, Widget::mDimension, Graphics::mHeight, Graphics::mWidth, Rect::width, Rect::x, and Rect::y.

◆ adjustSizeToScreen()

void Window::adjustSizeToScreen ( )

private

Definition at line 1285 of file window.cpp.

 {
     if (mGrip == nullptr)
         return;
  
     const int screenWidth = mainGraphics->mWidth;
     const int screenHeight = mainGraphics->mHeight;
     const int oldWidth = mDimension.width;
     const int oldHeight = mDimension.height;
     if (oldWidth + mDimension.x > screenWidth)
         mDimension.x = 0;
     if (oldHeight + mDimension.y > screenHeight)
         mDimension.x = 0;
     if (mDimension.width > screenWidth)
         mDimension.width = screenWidth;
     if (mDimension.height > screenHeight)
         mDimension.height = screenHeight;
     if (oldWidth != mDimension.width || oldHeight != mDimension.height)
         widgetResized(Event(this));
 }

References Rect::height, mainGraphics, Widget::mDimension, mGrip, Graphics::mHeight, Graphics::mWidth, widgetResized(), Rect::width, Rect::x, and Rect::y.

Referenced by adjustPositionAfterResize().

◆ canMove()

bool Window::canMove ( ) const

protected

Definition at line 977 of file window.cpp.

 {
     return !mStickyButtonLock || !mSticky;
 }

References mSticky, and mStickyButtonLock.

Referenced by mouseDragged(), ChatWindow::mouseDragged(), ShortcutWindow::mouseDragged(), and mousePressed().

◆ center()

void Window::center ( )

Positions the window in the center of it's parent.

Definition at line 1417 of file window.cpp.

 {
     setLocationRelativeTo(getParent());
 }

References Widget::getParent(), and setLocationRelativeTo().

Referenced by BankWindow::BankWindow(), ChangeEmailDialog::ChangeEmailDialog(), ChangePasswordDialog::ChangePasswordDialog(), CharCreateDialog::CharCreateDialog(), CharSelectDialog::CharSelectDialog(), ConnectionDialog::ConnectionDialog(), BuyDialog::init(), BuySellDialog::init(), MailEditWindow::MailEditWindow(), MailViewWindow::MailViewWindow(), MailWindow::MailWindow(), NpcDialog::NpcDialog(), OkDialog::OkDialog(), SellDialog::postInit(), ConfirmDialog::postInit(), EditDialog::postInit(), EmoteWindow::postInit(), LoginDialog::postInit(), SetupWindow::postInit(), TextSelectDialog::postInit(), RegisterDialog::RegisterDialog(), ShopWindow::ShopWindow(), TextCommandEditor::TextCommandEditor(), and WorldSelectDialog::WorldSelectDialog().

◆ centerHorisontally()

void Window::centerHorisontally ( )

Positions the window in the horisontal center of it's parent.

Definition at line 1422 of file window.cpp.

 {
     setLocationHorisontallyRelativeTo(getParent());
 }

References Widget::getParent(), and setLocationHorisontallyRelativeTo().

Referenced by OkDialog::OkDialog().

◆ clearLayout()

void Window::clearLayout ( )

Clears the window's layout (useful for redesigning the window). Does not delete the widgets!

Definition at line 1372 of file window.cpp.

 {
     clear();
  
     // Recreate layout instance when one is present
     if (mLayout != nullptr)
     {
         delete mLayout;
         mLayout = new Layout;
     }
 }

References BasicContainer::clear(), and mLayout.

Referenced by NpcDialog::buildLayout(), and NpcDialog::~NpcDialog().

◆ close()

void Window::close ( )

virtual

Overrideable functionality for when the window is to close. This allows for class implementations to clean up or do certain actions on window close they couldn't do otherwise.

Reimplemented in TradeWindow, TextDialog, ServerInfoWindow, ServerDialog, RegisterDialog, PincodeDialog, NpcSellDialog, MailEditWindow, LoginDialog, ItemAmountWindow, InventoryWindow, CharSelectDialog, and BuyDialog.

Definition at line 902 of file window.cpp.

 {
     setVisible(Visible_false);
 }

References setVisible(), and Visible_false.

Referenced by SellDialog::action(), BuySellDialog::action(), ShopWindow::action(), TextSelectDialog::action(), BuyDialog::close(), CharSelectDialog::close(), InventoryWindow::close(), LoginDialog::close(), NpcSellDialog::close(), RegisterDialog::close(), ServerDialog::close(), ServerInfoWindow::close(), EAthena::NpcHandler::closeDialog(), TmwAthena::NpcHandler::closeDialog(), PopupMenu::handleLink(), mousePressed(), Ea::NpcRecv::processNpcCommand(), SocialTab::~SocialTab(), and SocialWindow::~SocialWindow().

◆ draw()

void Window::draw ( Graphics *const graphics )

virtual

Draws the window.

Reimplemented from BasicContainer2.

Reimplemented in OutfitWindow, MiniStatusWindow, Minimap, EquipmentWindow, CutInWindow, ConnectionDialog, ChatWindow, and DebugWindow.

Definition at line 311 of file window.cpp.

 {
     if (mSkin == nullptr)
         return;
  
     BLOCK_START("Window::draw")
     bool update = false;
  
     if (mResizeHandles != mOldResizeHandles)
     {
         mRedraw = true;
         mOldResizeHandles = mResizeHandles;
     }
     if (mRedraw)
     {
         mLastRedraw = true;
         mRedraw = false;
         update = true;
         mVertexes->clear();
         graphics->calcWindow(mVertexes,
             0, 0,
             mDimension.width,
             mDimension.height,
             mSkin->getBorder());
  
         // Draw Close Button
         if (mCloseWindowButton)
         {
             const Image *const button = mSkin->getCloseImage(
                 mResizeHandles == CLOSE);
             if (button != nullptr)
             {
                 graphics->calcTileCollection(mVertexes,
                     button,
                     mCloseRect.x,
                     mCloseRect.y);
             }
         }
         // Draw Sticky Button
         if (mStickyButton)
         {
             const Image *const button = mSkin->getStickyImage(mSticky);
             if (button != nullptr)
             {
                 graphics->calcTileCollection(mVertexes,
                     button,
                     mStickyRect.x,
                     mStickyRect.y);
             }
         }
  
         if (mGrip != nullptr)
         {
             graphics->calcTileCollection(mVertexes,
                 mGrip,
                 mGripRect.x,
                 mGripRect.y);
         }
         graphics->finalize(mVertexes);
     }
     else
     {
         mLastRedraw = false;
     }
     graphics->drawTileCollection(mVertexes);
  
     // Draw title
     if (mShowTitle)
     {
         int x;
         switch (mCaptionAlign)
         {
             case Graphics::LEFT:
             default:
                 x = mCaptionOffsetX;
                 break;
             case Graphics::CENTER:
                 x = mCaptionOffsetX - mCaptionFont->getWidth(mCaption) / 2;
                 break;
             case Graphics::RIGHT:
                 x = mCaptionOffsetX - mCaptionFont->getWidth(mCaption);
                 break;
         }
         if (mTextChanged)
         {
             mTextChunk.textFont = mCaptionFont;
             mTextChunk.deleteImage();
             mTextChunk.text = mCaption;
             mTextChunk.color = mForegroundColor;
             mTextChunk.color2 = mForegroundColor2;
             mCaptionFont->generate(mTextChunk);
             mTextChanged = false;
         }
  
         const Image *const image = mTextChunk.img;
         if (image != nullptr)
             graphics->drawImage(image, x, mCaptionOffsetY);
     }
  
     if (update)
     {
         graphics->setRedraw(update);
         drawChildren(graphics);
         graphics->setRedraw(false);
     }
     else
     {
         drawChildren(graphics);
     }
     BLOCK_END("Window::draw")
 }

References BLOCK_END, BLOCK_START, Graphics::calcTileCollection(), Graphics::calcWindow(), Graphics::CENTER, ImageCollection::clear(), CLOSE, TextChunk::color, TextChunk::color2, TextChunk::deleteImage(), BasicContainer::drawChildren(), Graphics::drawImage(), Graphics::drawTileCollection(), Graphics::finalize(), Font::generate(), Skin::getBorder(), Skin::getCloseImage(), Skin::getStickyImage(), Font::getWidth(), Rect::height, TextChunk::img, Graphics::LEFT, mCaption, mCaptionAlign, mCaptionFont, mCaptionOffsetX, mCaptionOffsetY, mCloseRect, mCloseWindowButton, Widget::mDimension, Widget::mForegroundColor, Widget2::mForegroundColor2, mGrip, mGripRect, mLastRedraw, mOldResizeHandles, Widget::mRedraw, mResizeHandles, mShowTitle, mSkin, mSticky, mStickyButton, mStickyRect, mTextChanged, mTextChunk, mVertexes, Graphics::RIGHT, Graphics::setRedraw(), TextChunk::text, TextChunk::textFont, UserAgent::update(), Rect::width, Rect::x, x, and Rect::y.

Referenced by DebugWindow::draw(), ChatWindow::draw(), CutInWindow::draw(), EquipmentWindow::draw(), Minimap::draw(), and OutfitWindow::draw().

◆ enableVisibleSound()

void Window::enableVisibleSound ( bool b )

inline

Definition at line 481 of file window.h.

482 { mPlayVisibleSound = b; }

References mPlayVisibleSound.

Referenced by BankWindow::BankWindow(), ChatWindow::ChatWindow(), ClanWindow::ClanWindow(), CutInWindow::CutInWindow(), DebugWindow::DebugWindow(), DidYouKnowWindow::DidYouKnowWindow(), HelpWindow::HelpWindow(), BuyDialog::init(), BuySellDialog::init(), InventoryWindow::InventoryWindow(), KillStats::KillStats(), MailEditWindow::MailEditWindow(), MailViewWindow::MailViewWindow(), MailWindow::MailWindow(), Minimap::Minimap(), OutfitWindow::OutfitWindow(), SellDialog::postInit(), EquipmentWindow::postInit(), NpcDialog::postInit(), SetupWindow::postInit(), ShopWindow::postInit(), SkillDialog::postInit(), SocialWindow::postInit(), TextCommandEditor::postInit(), TextSelectDialog::postInit(), WhoIsOnline::postInit(), QuestsWindow::QuestsWindow(), ServerInfoWindow::ServerInfoWindow(), ShortcutWindow::ShortcutWindow(), StatusWindow::StatusWindow(), and TradeWindow::TradeWindow().

◆ ensureOnScreen()

void Window::ensureOnScreen ( )

private

Ensures the window is on the screen, moving it if necessary. This is used by loadWindowState and setVisible(true), and when the screen is resized.

Definition at line 1427 of file window.cpp.

 {
     // Skip when a window hasn't got any size initialized yet
     if (mDimension.width == 0 && mDimension.height == 0)
         return;
  
     // Check the left and bottom screen boundaries
     if (mDimension.x + mDimension.width > mainGraphics->mWidth)
         mDimension.x = mainGraphics->mWidth - mDimension.width;
     if (mDimension.y + mDimension.height > mainGraphics->mHeight)
         mDimension.y = mainGraphics->mHeight - mDimension.height;
  
     // But never allow the windows to disappear in to the right and top
     if (mDimension.x < 0)
         mDimension.x = 0;
     if (mDimension.y < 0)
         mDimension.y = 0;
 }

References Rect::height, mainGraphics, Widget::mDimension, Graphics::mHeight, Graphics::mWidth, Rect::width, Rect::x, and Rect::y.

Referenced by adjustPositionAfterResize(), loadWindowState(), and setVisible().

◆ getAlignment()

Graphics::Alignment Window::getAlignment ( ) const

inline

Gets the alignment of the caption.

Returns: The alignment of caption.

See also: setAlignment, Graphics

Definition at line 558 of file window.h.

559 { return mAlignment; }

References mAlignment.

◆ getAlowClose()

bool Window::getAlowClose ( ) const

inline

Definition at line 192 of file window.h.

193 { return mCloseWindowButton || mAllowClose; }

References mAllowClose, and mCloseWindowButton.

Referenced by PopupMenu::addWindowMenu().

◆ getCaption()

const std::string& Window::getCaption ( ) const

inline

Gets the caption of the window.

Returns: the caption of the window.

See also: setCaption

Definition at line 540 of file window.h.

541 { return mCaption; }

References mCaption.

Referenced by ConfirmDialog::postInit(), and ~Window().

◆ getChildrenArea()

Rect Window::getChildrenArea ( )

virtual

Gets the area of the widget occupied by the widget's children. By default this method returns an empty rectangle as not all widgets are containers. If you want to make a container this method should return the area where the children resides. This method is used when drawing children of a widget when computing clip rectangles for the children.

An example of a widget that overloads this method is ScrollArea. A ScrollArea has a view of its contant and that view is the children area. The size of a ScrollArea's children area might vary depending on if the scroll bars of the ScrollArea is shown or not.

Returns: The area of the widget occupied by the widget's children.

See also: BasicContainer; BasicContainer::getChildrenArea; BasicContainer::drawChildren

Reimplemented from BasicContainer.

Reimplemented in MiniStatusWindow.

Definition at line 1473 of file window.cpp.

 {
     return Rect(mPadding,
         mTitleBarHeight,
         mDimension.width - mPadding * 2,
         mDimension.height - mPadding - mTitleBarHeight);
 }

References Rect::height, Widget::mDimension, mPadding, mTitleBarHeight, and Rect::width.

Referenced by ChatWindow::adjustTabSize(), Minimap::draw2(), EquipmentWindow::postInit(), redraw(), Minimap::screenToMap(), WhoIsOnline::updateSize(), widgetResized(), and SetupWindow::widgetResized().

◆ getCloseButton()

bool Window::getCloseButton ( ) const

inline

Definition at line 186 of file window.h.

187 { return mCloseWindowButton; }

References mCloseWindowButton.

◆ getLayout()

Layout & Window::getLayout ( )

Gets the layout handler for this window.

Definition at line 1365 of file window.cpp.

 {
     if (mLayout == nullptr)
         mLayout = new Layout;
     return *mLayout;
 }

References mLayout.

Referenced by NpcDialog::buildLayout(), DidYouKnowWindow::DidYouKnowWindow(), EditServerDialog::EditServerDialog(), getPlacer(), HelpWindow::HelpWindow(), BuyDialog::init(), InventoryWindow::InventoryWindow(), MailWindow::MailWindow(), OutfitWindow::OutfitWindow(), place(), SellDialog::postInit(), TextSelectDialog::postInit(), QuestsWindow::QuestsWindow(), ServerDialog::ServerDialog(), ServerInfoWindow::ServerInfoWindow(), ShopWindow::ShopWindow(), ShortcutWindow::ShortcutWindow(), StatusWindow::StatusWindow(), TradeWindow::TradeWindow(), UpdaterWindow::UpdaterWindow(), and WorldSelectDialog::WorldSelectDialog().

◆ getMaxHeight()

int Window::getMaxHeight ( ) const

inline

Definition at line 229 of file window.h.

230 { return mMaxWinHeight; }

References mMaxWinHeight.

Referenced by loadWindowState(), and saveWindowState().

◆ getMaxWidth()

int Window::getMaxWidth ( ) const

inline

Definition at line 221 of file window.h.

222 { return mMaxWinWidth; }

References mMaxWinWidth.

Referenced by loadWindowState(), and saveWindowState().

◆ getMinHeight()

int Window::getMinHeight ( ) const

inline

Definition at line 213 of file window.h.

214 { return mMinWinHeight; }

References mMinWinHeight.

Referenced by loadWindowState(), and saveWindowState().

◆ getMinWidth()

int Window::getMinWidth ( ) const

inline

Definition at line 205 of file window.h.

206 { return mMinWinWidth; }

References mMinWinWidth.

Referenced by loadWindowState(), OkDialog::OkDialog(), ConfirmDialog::postInit(), and saveWindowState().

◆ getOption()

int Window::getOption	(	const std::string &	name,
		const int	def
	)		const

protected

Definition at line 1454 of file window.cpp.

 {
     if (mSkin != nullptr)
     {
         const int val = mSkin->getOption(name);
         if (val != 0)
             return val;
         return def;
     }
     return def;
 }

References Skin::getOption(), and mSkin.

Referenced by CharCreateDialog::CharCreateDialog(), EquipmentWindow::EquipmentWindow(), BuySellDialog::init(), OkDialog::OkDialog(), ConfirmDialog::postInit(), EditDialog::postInit(), SetupWindow::postInit(), ShopWindow::ShopWindow(), and Window().

◆ getOptionBool()

bool Window::getOptionBool	(	const std::string &	name,
		const bool	def
	)		const

protected

Definition at line 1466 of file window.cpp.

 {
     if (mSkin != nullptr)
         return mSkin->getOption(name, static_cast<int>(def)) != 0;
     return def;
 }

References Skin::getOption(), and mSkin.

Referenced by SocialWindow::addTab(), BuyDialog::init(), InventoryWindow::InventoryWindow(), SellDialog::postInit(), SocialWindow::postInit(), TextSelectDialog::postInit(), ServerDialog::ServerDialog(), Window(), and WorldSelectDialog::WorldSelectDialog().

◆ getPadding()

int Window::getPadding ( ) const

inline

Gets the padding of the window. The padding is the distance between the window border and the content.

Returns: The padding of the window.

See also: setPadding

Definition at line 504 of file window.h.

505 { return mPadding; }

References mPadding.

Referenced by EquipmentWindow::addBox(), CharSelectDialog::CharSelectDialog(), ChatWindow::ChatWindow(), EquipmentWindow::loadSlot(), NpcDialog::logic(), EditDialog::postInit(), EmoteWindow::postInit(), CharCreateDialog::setAttributes(), Minimap::setMap(), and ShortcutWindow::ShortcutWindow().

◆ getParentWindow()

Window* Window::getParentWindow ( ) const

inline

Returns the parent window.

Returns: The parent window or NULL if there is none.

Definition at line 310 of file window.h.

311 { return mParentWindow; }

References mParentWindow.

Referenced by EditServerDialog::EditServerDialog(), and ItemAmountWindow::ItemAmountWindow().

◆ getPlacer()

ContainerPlacer Window::getPlacer	(	const int	x,
		const int	y
	)

Returns a proxy for adding widgets in an inner table of the layout.

Definition at line 1391 of file window.cpp.

 {
     return ContainerPlacer(this, &getLayout().at(x, y));
 }

References getLayout(), x, and y.

Referenced by BankWindow::BankWindow(), CharSelectDialog::CharSelectDialog(), BuyDialog::init(), InventoryWindow::InventoryWindow(), ItemAmountWindow::ItemAmountWindow(), MailEditWindow::MailEditWindow(), MailViewWindow::MailViewWindow(), MailWindow::MailWindow(), SellDialog::postInit(), TextSelectDialog::postInit(), QuestsWindow::QuestsWindow(), QuitDialog::QuitDialog(), RegisterDialog::RegisterDialog(), ShopWindow::ShopWindow(), TextCommandEditor::TextCommandEditor(), TradeWindow::TradeWindow(), and UpdaterWindow::UpdaterWindow().

◆ getResizeHandles()

int Window::getResizeHandles ( const MouseEvent & event )

private

Determines if the mouse is in a resize area and returns appropriate resize handles. Also initializes drag offset in case the resize grip is used.

See also: ResizeHandles

Definition at line 1306 of file window.cpp.

 {
     if (event.getX() < 0 || event.getY() < 0)
         return 0;
  
     int resizeHandles = 0;
     const unsigned y = event.getY();
     const unsigned x = event.getX();
     if (mCloseRect.isPointInRect(x, y))
         return CLOSE;
  
     if (!mStickyButtonLock || !mSticky)
     {
         if ((mGrip != nullptr) &&
             (y > mTitleBarHeight ||
             (CAST_S32(y) < mPadding &&
             CAST_S32(mTitleBarHeight) > mPadding)))
         {
             if (!getWindowArea().isPointInRect(x, y)
                 && event.getSource() == this)
             {
                 resizeHandles |= (x > mDimension.width - resizeBorderWidth)
                     ? RIGHT : (x < resizeBorderWidth) ? LEFT : 0;
                 resizeHandles |= (y > mDimension.height - resizeBorderWidth)
                     ? BOTTOM : (y < resizeBorderWidth) ? TOP : 0;
             }
             if (x >= CAST_U32(mGripRect.x)
                 && y >= CAST_U32(mGripRect.y))
             {
                 mDragOffsetX = x;
                 mDragOffsetY = y;
                 resizeHandles |= BOTTOM | RIGHT;
             }
         }
     }
  
     return resizeHandles;
 }

References BOTTOM, CAST_S32, CAST_U32, CLOSE, Event::getSource(), getWindowArea(), MouseEvent::getX(), MouseEvent::getY(), Rect::height, Rect::isPointInRect(), LEFT, mCloseRect, Widget::mDimension, mDragOffsetX, mDragOffsetY, mGrip, mGripRect, mPadding, mSticky, mStickyButtonLock, mTitleBarHeight, resizeBorderWidth, RIGHT, TOP, Rect::width, Rect::x, x, Rect::y, and y.

Referenced by mousePressed(), and updateResizeHandler().

◆ getTitleBarHeight()

unsigned int Window::getTitleBarHeight ( ) const

inline

Gets the title bar height.

Returns: The title bar height.

See also: setTitleBarHeight

Definition at line 522 of file window.h.

523 { return mTitleBarHeight; }

References mTitleBarHeight.

Referenced by EquipmentWindow::addBox(), EquipmentWindow::loadSlot(), and Minimap::setMap().

◆ getTitlePadding()

int Window::getTitlePadding ( ) const

inlineprotected

Definition at line 602 of file window.h.

603 { return mTitlePadding; }

References mTitlePadding.

Referenced by CharCreateDialog::CharCreateDialog(), ChatWindow::ChatWindow(), EmoteWindow::postInit(), and ShortcutWindow::ShortcutWindow().

◆ getWindowArea()

Rect Window::getWindowArea ( ) const

Definition at line 1446 of file window.cpp.

 {
     return Rect(mPadding,
         mPadding,
         mDimension.width - mPadding * 2,
         mDimension.height - mPadding * 2);
 }

References Rect::height, Widget::mDimension, mPadding, and Rect::width.

Referenced by getResizeHandles(), and isResizeAllowed().

◆ getWindowName()

const std::string& Window::getWindowName ( ) const

inline

Returns the name of the window. This is not the window title.

Definition at line 361 of file window.h.

362 { return mWindowName; }

References mWindowName.

Referenced by CharCreateDialog::CharCreateDialog(), InventoryWindow::InventoryWindow(), Minimap::Minimap(), and Minimap::~Minimap().

◆ isDefaultVisible()

bool Window::isDefaultVisible ( ) const

inline

Returns whether the window is visible by default.

Definition at line 282 of file window.h.

283 { return mDefaultVisible; }

References mDefaultVisible.

◆ isMovable()

bool Window::isMovable ( ) const

inline

Checks if the window is movable.

Returns: True if the window is movable, false otherwise.

See also: setMovable

Definition at line 576 of file window.h.

577 { return mMovable == Move_true; }

References mMovable, and Move_true.

Referenced by mouseDragged(), ChatWindow::mouseDragged(), and ShortcutWindow::mouseDragged().

◆ isResizable()

bool Window::isResizable ( ) const

Returns whether the window can be resized.

Definition at line 756 of file window.cpp.

 {
     return mGrip != nullptr;
 }

References mGrip.

◆ isResizeAllowed()

bool Window::isResizeAllowed ( const MouseEvent & event ) const

Definition at line 1345 of file window.cpp.

 {
     const int y = event.getY();
  
     if ((mGrip != nullptr) &&
         (y > CAST_S32(mTitleBarHeight) ||
         y < mPadding))
     {
         const int x = event.getX();
  
         if (!getWindowArea().isPointInRect(x, y) && event.getSource() == this)
             return true;
  
         if (x >= mGripRect.x && y >= mGripRect.y)
             return true;
     }
  
     return false;
 }

References CAST_S32, Event::getSource(), getWindowArea(), mGrip, mGripRect, mPadding, mTitleBarHeight, Rect::x, x, Rect::y, and y.

Referenced by ChatWindow::mousePressed().

◆ isSticky()

bool Window::isSticky ( ) const

inline

Returns whether the window is sticky.

Definition at line 253 of file window.h.

254 { return mSticky; }

References mSticky.

Referenced by PopupMenu::addWindowMenu(), SetupWindow::hideWindows(), loadWindowState(), Minimap::Minimap(), mousePressed(), saveWindowState(), Minimap::setMap(), and Minimap::toggle().

◆ isStickyButtonLock()

bool Window::isStickyButtonLock ( ) const

inline

Returns whether the window sticky locking window.

Definition at line 264 of file window.h.

265 { return mStickyButtonLock; }

References mStickyButtonLock.

Referenced by PopupMenu::addWindowMenu().

◆ isWindowVisible()

bool Window::isWindowVisible ( ) const

inline

Definition at line 484 of file window.h.

485 { return mVisible == Visible_true; }

Widget::mVisible

Visible mVisible

Definition: widget.h:963

Visible_true

const bool Visible_true

Definition: visible.h:30

References Widget::mVisible, and Visible_true.

Referenced by InventoryWindow::action(), TradeWindow::action(), InputManager::handleAssignKey(), Game::handleInput(), InventoryWindow::mouseClicked(), ItemShortcutContainer::mousePressed(), EAthena::MailRecv::processMailOpen(), ChatWindow::requestChatFocus(), saveWindowState(), ChatWindow::scroll(), DidYouKnowWindow::setVisible(), Actions::showHelpPage(), Actions::showHideWindow(), PopupMenu::showPopup(), ClanWindow::slowLogic(), DebugWindow::slowLogic(), WhoIsOnline::slowLogic(), Minimap::toggle(), InputManager::updateConditionMask(), and InventoryWindow::updateDropButton().

◆ loadWindowState()

void Window::loadWindowState ( )

Reads the position (and the size for resizable windows) in the configuration based on the given string. Uses the default values when config values are missing. Don't forget to set these default values and resizable before calling this function.

Definition at line 1087 of file window.cpp.

 {
     const std::string &name = mWindowName;
     if (name.empty())
         return;
  
     setPosition(config.getValueInt(name + "WinX", mDefaultX),
         config.getValueInt(name + "WinY", mDefaultY));
  
     if (mSaveVisible)
     {
         setVisible(fromBool(config.getValueBool(name
             + "Visible", mDefaultVisible), Visible));
     }
  
     if (mStickyButton)
     {
         setSticky(config.getValueBool(name
             + "Sticky", isSticky()));
     }
  
     if (mGrip != nullptr)
     {
         int width = config.getValueInt(name + "WinWidth", mDefaultWidth);
         int height = config.getValueInt(name + "WinHeight", mDefaultHeight);
  
         if (getMinWidth() > width)
             width = getMinWidth();
         else if (getMaxWidth() < width)
             width = getMaxWidth();
         if (getMinHeight() > height)
             height = getMinHeight();
         else if (getMaxHeight() < height)
             height = getMaxHeight();
  
         setSize(width, height);
     }
     else
     {
         setSize(mDefaultWidth, mDefaultHeight);
     }
  
     // Check if the window is off screen...
     ensureOnScreen();
  
     if (viewport != nullptr)
     {
         int width = mDimension.width;
         int height = mDimension.height;
  
         if (mDimension.x + width > viewport->getWidth())
             width = viewport->getWidth() - mDimension.x;
         if (mDimension.y + height > viewport->getHeight())
             height = viewport->getHeight() - mDimension.y;
         if (width < 0)
             width = 0;
         if (height < 0)
             height = 0;
         setSize(width, height);
     }
 }

References config, ensureOnScreen(), fromBool, Widget::getHeight(), getMaxHeight(), getMaxWidth(), getMinHeight(), getMinWidth(), ConfigurationObject::getValueBool(), ConfigurationObject::getValueInt(), Widget::getWidth(), Rect::height, isSticky(), mDefaultHeight, mDefaultVisible, mDefaultWidth, mDefaultX, mDefaultY, Widget::mDimension, mGrip, mSaveVisible, mStickyButton, mWindowName, Widget::setPosition(), Widget::setSize(), setSticky(), setVisible(), viewport, Rect::width, Rect::x, and Rect::y.

Referenced by BankWindow::BankWindow(), ChatWindow::ChatWindow(), ClanWindow::ClanWindow(), DebugWindow::DebugWindow(), DidYouKnowWindow::DidYouKnowWindow(), EditServerDialog::EditServerDialog(), EquipmentWindow::EquipmentWindow(), HelpWindow::HelpWindow(), BuyDialog::init(), BuySellDialog::init(), InventoryWindow::InventoryWindow(), KillStats::KillStats(), MailEditWindow::MailEditWindow(), MailViewWindow::MailViewWindow(), MailWindow::MailWindow(), Minimap::Minimap(), NpcDialog::NpcDialog(), OutfitWindow::OutfitWindow(), SellDialog::postInit(), LoginDialog::postInit(), SkillDialog::postInit(), SocialWindow::postInit(), TextSelectDialog::postInit(), WhoIsOnline::postInit(), QuestsWindow::QuestsWindow(), ServerDialog::ServerDialog(), ServerInfoWindow::ServerInfoWindow(), ShopWindow::ShopWindow(), ShortcutWindow::ShortcutWindow(), StatusWindow::StatusWindow(), TradeWindow::TradeWindow(), and UpdaterWindow::UpdaterWindow().

◆ mouseDragged()

void Window::mouseDragged ( MouseEvent & event )

virtual

Implements window resizing and makes sure the window is not dragged/resized outside of the screen.

Reimplemented from MouseListener.

Reimplemented in ShortcutWindow, OutfitWindow, and ChatWindow.

Definition at line 982 of file window.cpp.

 {
     if (canMove())
     {
         if (!event.isConsumed() && event.getSource() == this)
         {
             if (isMovable() && mMoved)
             {
                 setPosition(event.getX() - mDragOffsetX + getX(),
                     event.getY() - mDragOffsetY + getY());
             }
  
             event.consume();
         }
     }
     else
     {
         if (!event.isConsumed() && event.getSource() == this)
             event.consume();
         return;
     }
  
     // Keep guichan window inside screen when it may be moved
     if (isMovable() && mMoved)
     {
         setPosition(std::min(mainGraphics->mWidth - mDimension.width,
             std::max(0, mDimension.x)),
             std::min(mainGraphics->mHeight - mDimension.height,
             std::max(0, mDimension.y)));
     }
  
     if ((mouseResize != 0) && !mMoved)
     {
         const int dy = event.getY() - mDragOffsetY;
         Rect newDim = getDimension();
  
         if ((mouseResize & (TOP | BOTTOM)) != 0)
         {
             const int newHeight = newDim.height
                 + ((mouseResize & TOP) != 0 ? -dy : dy);
             newDim.height = std::min(mMaxWinHeight,
                 std::max(mMinWinHeight, newHeight));
  
             if ((mouseResize & TOP) != 0)
                 newDim.y -= newDim.height - getHeight();
         }
  
         if ((mouseResize & (LEFT | RIGHT)) != 0)
         {
             const int dx = event.getX() - mDragOffsetX;
             const int newWidth = newDim.width
                 + ((mouseResize & LEFT) != 0 ? -dx : dx);
             newDim.width = std::min(mMaxWinWidth,
                 std::max(mMinWinWidth, newWidth));
  
             if ((mouseResize & LEFT) != 0)
                 newDim.x -= newDim.width - mDimension.width;
         }
  
         // Keep guichan window inside screen (supports resizing any side)
         if (newDim.x < 0)
         {
             newDim.width += newDim.x;
             newDim.x = 0;
         }
         if (newDim.y < 0)
         {
             newDim.height += newDim.y;
             newDim.y = 0;
         }
         if (newDim.x + newDim.width > mainGraphics->mWidth)
             newDim.width = mainGraphics->mWidth - newDim.x;
         if (newDim.y + newDim.height > mainGraphics->mHeight)
             newDim.height = mainGraphics->mHeight - newDim.y;
  
         // Update mouse offset when dragging bottom or right border
         if ((mouseResize & BOTTOM) != 0)
             mDragOffsetY += newDim.height - mDimension.height;
  
         if ((mouseResize & RIGHT) != 0)
             mDragOffsetX += newDim.width - mDimension.width;
  
         // Set the new window and content dimensions
         setDimension(newDim);
     }
 }

References BOTTOM, canMove(), Widget::getDimension(), Widget::getHeight(), Event::getSource(), MouseEvent::getX(), Widget::getX(), MouseEvent::getY(), Widget::getY(), Rect::height, InputGuiEvent::isConsumed(), isMovable(), LEFT, mainGraphics, Widget::mDimension, mDragOffsetX, mDragOffsetY, Graphics::mHeight, mMaxWinHeight, mMaxWinWidth, mMinWinHeight, mMinWinWidth, mMoved, mouseResize, Graphics::mWidth, RIGHT, Widget::setDimension(), Widget::setPosition(), TOP, Rect::width, Rect::x, and Rect::y.

Referenced by ChatWindow::mouseDragged(), OutfitWindow::mouseDragged(), and ShortcutWindow::mouseDragged().

◆ mouseEntered()

void Window::mouseEntered ( MouseEvent & event )

virtual

Called when the mouse has entered into the widget area.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Reimplemented in ChatWindow.

Definition at line 919 of file window.cpp.

 {
     updateResizeHandler(event);
 }

References updateResizeHandler().

Referenced by ChatWindow::mouseEntered().

◆ mouseExited()

void Window::mouseExited ( MouseEvent & event )

virtual

When the mouse leaves the window this ensures that the custom cursor is restored back to it's standard image.

Reimplemented from MouseListener.

Reimplemented in MiniStatusWindow, Minimap, ItemAmountWindow, InventoryWindow, EquipmentWindow, and ChatWindow.

Definition at line 924 of file window.cpp.

 {
     if ((mGrip != nullptr) && (mouseResize == 0) && (gui != nullptr))
         gui->setCursorType(Cursor::CURSOR_POINTER);
 }

References Cursor::CURSOR_POINTER, gui, mGrip, mouseResize, and Gui::setCursorType().

Referenced by ChatWindow::mouseExited(), Minimap::mouseExited(), and MiniStatusWindow::mouseExited().

◆ mouseMoved()

void Window::mouseMoved ( MouseEvent & event )

virtual

Implements custom cursor image changing context, based on mouse relative position.

Reimplemented from MouseListener.

Reimplemented in MiniStatusWindow, Minimap, ItemAmountWindow, InventoryWindow, EquipmentWindow, and ChatWindow.

Definition at line 967 of file window.cpp.

 {
     updateResizeHandler(event);
     if ((popupManager != nullptr) && !event.isConsumed())
     {
         PopupManager::hideBeingPopup();
         PopupManager::hideTextPopup();
     }
 }

References PopupManager::hideBeingPopup(), PopupManager::hideTextPopup(), InputGuiEvent::isConsumed(), popupManager, and updateResizeHandler().

Referenced by ChatWindow::mouseMoved(), EquipmentWindow::mouseMoved(), InventoryWindow::mouseMoved(), ItemAmountWindow::mouseMoved(), Minimap::mouseMoved(), MiniStatusWindow::mouseMoved(), and setVisible().

◆ mousePressed()

void Window::mousePressed ( MouseEvent & event )

virtual

Starts window resizing when appropriate.

Reimplemented from MouseListener.

Reimplemented in ShortcutWindow, OutfitWindow, NpcDialog, MiniStatusWindow, Minimap, EquipmentWindow, and ChatWindow.

Definition at line 836 of file window.cpp.

 {
     if (event.isConsumed())
         return;
  
     if (event.getSource() == this)
     {
         if (getParent() != nullptr)
             getParent()->moveToTop(this);
  
         mDragOffsetX = event.getX();
         mDragOffsetY = event.getY();
         mMoved = event.getY() <= CAST_S32(mTitleBarHeight);
     }
  
     const MouseButtonT button = event.getButton();
     if (button == MouseButton::LEFT)
     {
         const int x = event.getX();
         const int y = event.getY();
  
         // Handle close button
         if (mCloseWindowButton &&
             mSkin != nullptr &&
             mCloseRect.isPointInRect(x, y))
         {
             mouseResize = 0;
             mMoved = false;
             event.consume();
             close();
             return;
         }
  
         // Handle sticky button
         if (mStickyButton &&
             mSkin != nullptr &&
             mStickyRect.isPointInRect(x, y))
         {
             setSticky(!isSticky());
             mouseResize = 0;
             mMoved = false;
             event.consume();
             return;
         }
  
         // Handle window resizing
         mouseResize = getResizeHandles(event) & resizeMask;
         if (mouseResize != 0)
             event.consume();
         if (canMove())
             mMoved = (mouseResize == 0);
         else
             mMoved = false;
     }
 #ifndef DYECMD
     else if (button == MouseButton::RIGHT)
     {
         if (popupMenu != nullptr)
         {
             event.consume();
             popupMenu->showWindowPopup(this);
         }
     }
 #endif  // DYECMD
 }

References canMove(), CAST_S32, close(), Widget::getParent(), getResizeHandles(), Event::getSource(), InputGuiEvent::isConsumed(), Rect::isPointInRect(), isSticky(), MouseButton::LEFT, mCloseRect, mCloseWindowButton, mDragOffsetX, mDragOffsetY, mMoved, mouseResize, Widget::moveToTop(), mSkin, mStickyButton, mStickyRect, mTitleBarHeight, popupMenu, resizeMask, MouseButton::RIGHT, setSticky(), PopupMenu::showWindowPopup(), x, and y.

Referenced by ChatWindow::mousePressed(), EquipmentWindow::mousePressed(), Minimap::mousePressed(), NpcDialog::mousePressed(), OutfitWindow::mousePressed(), and ShortcutWindow::mousePressed().

◆ mouseReleased()

void Window::mouseReleased ( MouseEvent & event )

virtual

When the mouse button has been let go, this ensures that the mouse custom cursor is restored back to it's standard image.

Reimplemented from MouseListener.

Reimplemented in OutfitWindow, Minimap, and EquipmentWindow.

Definition at line 907 of file window.cpp.

 {
     if ((mGrip != nullptr) && (mouseResize != 0))
     {
         mouseResize = 0;
         if (gui != nullptr)
             gui->setCursorType(Cursor::CURSOR_POINTER);
     }
  
     mMoved = false;
 }

References Cursor::CURSOR_POINTER, gui, mGrip, mMoved, mouseResize, and Gui::setCursorType().

Referenced by EquipmentWindow::mouseReleased(), Minimap::mouseReleased(), and OutfitWindow::mouseReleased().

◆ place()

LayoutCell & Window::place	(	const int	x,
		const int	y,
		Widget *const	wg,
		const int	w,
		const int	h
	)

Adds a widget to the window and sets it at given cell.

Definition at line 1384 of file window.cpp.

 {
     add(wg);
     return getLayout().place(wg, x, y, w, h);
 }

References BasicContainer2::add(), getLayout(), LayoutCell::place(), x, and y.

Referenced by ShortcutWindow::addButton(), ChangePasswordDialog::ChangePasswordDialog(), ConnectionDialog::ConnectionDialog(), DidYouKnowWindow::DidYouKnowWindow(), EditServerDialog::EditServerDialog(), HelpWindow::HelpWindow(), InventoryWindow::InventoryWindow(), KillStats::KillStats(), LoginDialog::LoginDialog(), OutfitWindow::OutfitWindow(), PincodeDialog::PincodeDialog(), NpcDialog::placeIntInputControls(), NpcDialog::placeItemInputControls(), NpcDialog::placeMenuControls(), NpcDialog::placeNormalControls(), NpcDialog::placeSkinControls(), NpcDialog::placeTextInputControls(), SocialWindow::postInit(), ServerDialog::ServerDialog(), ServerInfoWindow::ServerInfoWindow(), ShortcutWindow::ShortcutWindow(), SkillDialog::SkillDialog(), StatusWindow::StatusWindow(), TextDialog::TextDialog(), TradeWindow::TradeWindow(), and WorldSelectDialog::WorldSelectDialog().

◆ postInit()

void Window::postInit ( )

virtual

Reimplemented from Widget.

Reimplemented in WorldSelectDialog, WhoIsOnline, UpdaterWindow, TextSelectDialog, TextDialog, TextCommandEditor, SocialWindow, SkillDialog, ShopWindow, SetupWindow, ServerInfoWindow, ServerDialog, RegisterDialog, QuitDialog, PincodeDialog, NpcDialog, LoginDialog, ItemAmountWindow, InventoryWindow, EquipmentWindow, EmoteWindow, EditServerDialog, EditDialog, DidYouKnowWindow, DebugWindow, ConnectionDialog, ConfirmDialog, ClanWindow, ChatWindow, and CharSelectDialog.

Definition at line 249 of file window.cpp.

 {
     if (mInit)
     {
         reportAlways("error: Window created with calling postInit() "
             "more than once: %s",
             mWindowName.c_str())
     }
     mInit = true;
 }

References mInit, mWindowName, and reportAlways.

◆ redraw()

void Window::redraw ( )

Definition at line 1406 of file window.cpp.

 {
     if (mLayout != nullptr)
     {
         const Rect area = getChildrenArea();
         int w = area.width;
         int h = area.height;
         mLayout->reflow(w, h);
     }
 }

References getChildrenArea(), Rect::height, mLayout, Layout::reflow(), and Rect::width.

Referenced by NpcDialog::buildLayout().

◆ reflowLayout()

void Window::reflowLayout	(	int	w,
		int	h
	)

Computes the position of the widgets according to the current layout. Resizes the window so that the layout fits. Deletes the layout.

Parameters

w	if non-zero, force the window to this width.
h	if non-zero, force the window to this height.

Note: This function is meant to be called with fixed-size windows.

Definition at line 1396 of file window.cpp.

 {
     if (mLayout == nullptr)
         return;
  
     mLayout->reflow(w, h);
     delete2(mLayout)
     setContentSize(w, h);
 }

References delete2, mLayout, Layout::reflow(), and setContentSize().

Referenced by BankWindow::BankWindow(), ChangePasswordDialog::ChangePasswordDialog(), CharSelectDialog::CharSelectDialog(), ConnectionDialog::ConnectionDialog(), ItemAmountWindow::ItemAmountWindow(), PincodeDialog::PincodeDialog(), LoginDialog::postInit(), QuitDialog::QuitDialog(), RegisterDialog::RegisterDialog(), TextCommandEditor::TextCommandEditor(), TextDialog::TextDialog(), and WorldSelectDialog::WorldSelectDialog().

◆ resetToDefaultSize()

void Window::resetToDefaultSize ( )

virtual

Reset the win pos and size to default. Don't forget to set defaults first.

Definition at line 1259 of file window.cpp.

 {
     setPosition(mDefaultX, mDefaultY);
     setSize(mDefaultWidth, mDefaultHeight);
     saveWindowState();
 }

References mDefaultHeight, mDefaultWidth, mDefaultX, mDefaultY, saveWindowState(), Widget::setPosition(), and Widget::setSize().

Referenced by Minimap::setMap().

◆ resizeToContent()

void Window::resizeToContent ( )

virtual

Resizes the window to fit the content.

Definition at line 1481 of file window.cpp.

 {
     int w = 0;
     int h = 0;
     for (WidgetListConstIterator it = mWidgets.begin();
           it != mWidgets.end(); ++ it)
     {
         const Widget *const widget = *it;
         const int x = widget->getX();
         const int y = widget->getY();
         const int width = widget->getWidth();
         const int height = widget->getHeight();
         if (x + width > w)
             w = x + width;
  
         if (y + height > h)
             h = y + height;
     }
  
     setSize(w + 2 * mPadding,
         h + mPadding + mTitleBarHeight);
 }

References Widget::getHeight(), Widget::getWidth(), Widget::getX(), Widget::getY(), mPadding, mTitleBarHeight, BasicContainer::mWidgets, Widget::setSize(), x, and y.

◆ safeDraw()

void Window::safeDraw ( Graphics *const graphics )

virtual

Reimplemented from BasicContainer2.

Reimplemented in OutfitWindow, MiniStatusWindow, Minimap, EquipmentWindow, CutInWindow, ConnectionDialog, ChatWindow, and DebugWindow.

Definition at line 423 of file window.cpp.

 {
     if (mSkin == nullptr)
         return;
  
     BLOCK_START("Window::safeDraw")
  
     graphics->drawImageRect(0, 0,
         mDimension.width,
         mDimension.height,
         mSkin->getBorder());
  
     // Draw Close Button
     if (mCloseWindowButton)
     {
         const Image *const button = mSkin->getCloseImage(
             mResizeHandles == CLOSE);
         if (button != nullptr)
             graphics->drawImage(button, mCloseRect.x, mCloseRect.y);
     }
     // Draw Sticky Button
     if (mStickyButton)
     {
         const Image *const button = mSkin->getStickyImage(mSticky);
         if (button != nullptr)
             graphics->drawImage(button, mStickyRect.x, mStickyRect.y);
     }
  
     if (mGrip != nullptr)
         graphics->drawImage(mGrip, mGripRect.x, mGripRect.y);
  
     // Draw title
     if (mShowTitle)
     {
         int x;
         switch (mCaptionAlign)
         {
             case Graphics::LEFT:
             default:
                 x = mCaptionOffsetX;
                 break;
             case Graphics::CENTER:
                 x = mCaptionOffsetX - mCaptionFont->getWidth(mCaption) / 2;
                 break;
             case Graphics::RIGHT:
                 x = mCaptionOffsetX - mCaptionFont->getWidth(mCaption);
                 break;
         }
         if (mTextChanged)
         {
             mTextChunk.textFont = mCaptionFont;
             mTextChunk.deleteImage();
             mTextChunk.text = mCaption;
             mTextChunk.color = mForegroundColor;
             mTextChunk.color2 = mForegroundColor2;
             mCaptionFont->generate(mTextChunk);
             mTextChanged = false;
         }
  
         const Image *const image = mTextChunk.img;
         if (image != nullptr)
             graphics->drawImage(image, x, mCaptionOffsetY);
     }
  
     safeDrawChildren(graphics);
  
     BLOCK_END("Window::safeDraw")
 }

References BLOCK_END, BLOCK_START, Graphics::CENTER, CLOSE, TextChunk::color, TextChunk::color2, TextChunk::deleteImage(), Graphics::drawImage(), Graphics::drawImageRect(), Font::generate(), Skin::getBorder(), Skin::getCloseImage(), Skin::getStickyImage(), Font::getWidth(), Rect::height, TextChunk::img, Graphics::LEFT, mCaption, mCaptionAlign, mCaptionFont, mCaptionOffsetX, mCaptionOffsetY, mCloseRect, mCloseWindowButton, Widget::mDimension, Widget::mForegroundColor, Widget2::mForegroundColor2, mGrip, mGripRect, mResizeHandles, mShowTitle, mSkin, mSticky, mStickyButton, mStickyRect, mTextChanged, mTextChunk, Graphics::RIGHT, BasicContainer::safeDrawChildren(), TextChunk::text, TextChunk::textFont, Rect::width, Rect::x, x, and Rect::y.

Referenced by DebugWindow::safeDraw(), ChatWindow::safeDraw(), CutInWindow::safeDraw(), EquipmentWindow::safeDraw(), Minimap::safeDraw(), and OutfitWindow::safeDraw().

◆ saveWindowState()

void Window::saveWindowState ( )

Saves the window state so that when the window is reloaded, it'll maintain its previous state and location.

Definition at line 1149 of file window.cpp.

 {
     // Saving X, Y and Width and Height for resizables in the config
     if (!mWindowName.empty() && mWindowName != "window")
     {
         config.setValue(mWindowName + "WinX", mDimension.x);
         config.setValue(mWindowName + "WinY", mDimension.y);
  
         if (mSaveVisible)
             config.setValue(mWindowName + "Visible", isWindowVisible());
  
         if (mStickyButton)
             config.setValue(mWindowName + "Sticky", isSticky());
  
         if (mGrip != nullptr)
         {
             if (getMinWidth() > mDimension.width)
                 setWidth(getMinWidth());
             else if (getMaxWidth() < mDimension.width)
                 setWidth(getMaxWidth());
             if (getMinHeight() > mDimension.height)
                 setHeight(getMinHeight());
             else if (getMaxHeight() < mDimension.height)
                 setHeight(getMaxHeight());
  
             config.setValue(mWindowName + "WinWidth", mDimension.width);
             config.setValue(mWindowName + "WinHeight", mDimension.height);
         }
     }
 }

References config, getMaxHeight(), getMaxWidth(), getMinHeight(), getMinWidth(), Rect::height, isSticky(), isWindowVisible(), Widget::mDimension, mGrip, mSaveVisible, mStickyButton, mWindowName, Widget::setHeight(), Configuration::setValue(), Widget::setWidth(), Rect::width, Rect::x, and Rect::y.

Referenced by resetToDefaultSize(), and ~Window().

◆ scheduleDelete()

void Window::scheduleDelete ( )

virtual

Schedule this window for deletion. It will be deleted at the start of the next logic update.

Reimplemented in TextCommandEditor, and ChatWindow.

Definition at line 831 of file window.cpp.

 {
     windowContainer->scheduleDelete(this);
 }

References WindowContainer::scheduleDelete(), and windowContainer.

Referenced by CharCreateDialog::action(), ConfirmDialog::action(), EditDialog::action(), EditServerDialog::action(), MailViewWindow::action(), OkDialog::action(), QuitDialog::action(), ServerDialog::action(), InventoryWindow::close(), ItemAmountWindow::close(), MailEditWindow::close(), PincodeDialog::close(), ServerInfoWindow::close(), TextDialog::close(), DialogsManager::closeDialogs(), PincodeManager::closeDialogs(), createGuiWindows(), WindowManager::createWindows(), UpdaterWindow::deleteSelf(), EditServerDialog::keyPressed(), EAthena::BeingRecv::processBeingResurrect(), TmwAthena::BeingRecv::processBeingResurrect(), EAthena::CharServerRecv::processCharCreate(), TmwAthena::CharServerRecv::processCharCreate(), ChatWindow::scheduleDelete(), TextCommandEditor::scheduleDelete(), EggSelectionDialog::sellAction(), InsertCardDialog::sellAction(), SellDialog::setVisible(), BuyDialog::setVisible(), BuySellDialog::setVisible(), NpcDialog::setVisible(), TextSelectDialog::setVisible(), LocalPlayer::slowLogic(), Game::slowLogic(), SocialTab::~SocialTab(), and SocialWindow::~SocialWindow().

◆ setAlignment()

void Window::setAlignment ( Graphics::Alignment alignment )

inline

Sets the alignment of the caption.

Parameters

alignment The alignment of the caption.

See also: getAlignment, Graphics

Definition at line 549 of file window.h.

550 { mAlignment = alignment; }

References mAlignment.

◆ setAllowClose()

void Window::setAllowClose ( const bool b )

inline

Definition at line 189 of file window.h.

190 { mAllowClose = b; }

References mAllowClose.

Referenced by ShortcutWindow::ShortcutWindow().

◆ setCaption()

void Window::setCaption ( const std::string & caption )

inline

Sets the caption of the window.

Parameters

caption The caption of the window.

See also: getCaption

Definition at line 531 of file window.h.

532 { mCaption = caption; mTextChanged = true; }

References mCaption, and mTextChanged.

Referenced by WhoIsOnline::action(), CharSelectDialog::CharSelectDialog(), EggSelectionDialog::EggSelectionDialog(), InsertCardDialog::InsertCardDialog(), InventoryWindow::InventoryWindow(), ItemAmountWindow::ItemAmountWindow(), NpcDialog::postInit(), Ea::NpcRecv::processChangeTitle(), EAthena::InventoryRecv::processInventoryStartContinue(), Ea::TradeRecv::processTradeResponseContinue(), ServerDialog::ServerDialog(), Minimap::setMap(), WhoIsOnline::slowLogic(), StatusWindow::StatusWindow(), ShopWindow::updateShopName(), and WhoIsOnline::updateWindow().

◆ setCaptionFont()

void Window::setCaptionFont ( Font * font )

inline

Definition at line 478 of file window.h.

479 { mCaptionFont = font; }

References mCaptionFont.

Referenced by TradeWindow::initTrade().

◆ setCloseButton()

void Window::setCloseButton ( const bool flag )

Sets whether or not the window has a close button.

Definition at line 749 of file window.cpp.

 {
     mCloseWindowButton = flag;
     if (flag)
         mAllowClose = true;
 }

References mAllowClose, and mCloseWindowButton.

Referenced by BankWindow::BankWindow(), CharSelectDialog::CharSelectDialog(), ClanWindow::ClanWindow(), DebugWindow::DebugWindow(), DidYouKnowWindow::DidYouKnowWindow(), EquipmentWindow::EquipmentWindow(), HelpWindow::HelpWindow(), BuyDialog::init(), BuySellDialog::init(), InventoryWindow::InventoryWindow(), KillStats::KillStats(), LoginDialog::LoginDialog(), MailEditWindow::MailEditWindow(), MailViewWindow::MailViewWindow(), MailWindow::MailWindow(), OutfitWindow::OutfitWindow(), SellDialog::postInit(), SocialWindow::postInit(), TextSelectDialog::postInit(), WhoIsOnline::postInit(), QuestsWindow::QuestsWindow(), RegisterDialog::RegisterDialog(), ServerDialog::ServerDialog(), ServerInfoWindow::ServerInfoWindow(), SetupWindow::SetupWindow(), ShopWindow::ShopWindow(), CutInWindow::show(), SkillDialog::SkillDialog(), StatusWindow::StatusWindow(), and TradeWindow::TradeWindow().

◆ setContentSize()

void Window::setContentSize	(	int	width,
		int	height
	)

Sets the size of this window.

Definition at line 492 of file window.cpp.

 {
     width = width + 2 * mPadding;
     height = height + mPadding + mTitleBarHeight;
  
     if (mMinWinWidth > width)
         width = mMinWinWidth;
     else if (mMaxWinWidth < width)
         width = mMaxWinWidth;
     if (mMinWinHeight > height)
         height = mMinWinHeight;
     else if (mMaxWinHeight < height)
         height = mMaxWinHeight;
  
     setSize(width, height);
 }

References mMaxWinHeight, mMaxWinWidth, mMinWinHeight, mMinWinWidth, mPadding, mTitleBarHeight, and Widget::setSize().

Referenced by BankWindow::BankWindow(), ChangeEmailDialog::ChangeEmailDialog(), CharCreateDialog::CharCreateDialog(), DidYouKnowWindow::DidYouKnowWindow(), EditServerDialog::EditServerDialog(), HelpWindow::HelpWindow(), BuySellDialog::init(), NpcDialog::NpcDialog(), OkDialog::OkDialog(), ConfirmDialog::postInit(), EditDialog::postInit(), LoginDialog::postInit(), SetupWindow::postInit(), reflowLayout(), ServerDialog::ServerDialog(), ServerInfoWindow::ServerInfoWindow(), CharCreateDialog::setAttributes(), and MiniStatusWindow::updateBars().

◆ setDefaultSize() [1/3]

void Window::setDefaultSize ( )

Set the default win pos and size to the current ones.

Definition at line 1198 of file window.cpp.

 {
     mDefaultX = mDimension.x;
     mDefaultY = mDimension.y;
     mDefaultWidth = mDimension.width;
     mDefaultHeight = mDimension.height;
 }

References Rect::height, mDefaultHeight, mDefaultWidth, mDefaultX, mDefaultY, Widget::mDimension, Rect::width, Rect::x, and Rect::y.

Referenced by BankWindow::BankWindow(), ChatWindow::ChatWindow(), ClanWindow::ClanWindow(), DebugWindow::DebugWindow(), DidYouKnowWindow::DidYouKnowWindow(), EditServerDialog::EditServerDialog(), HelpWindow::HelpWindow(), BuyDialog::init(), BuySellDialog::init(), InventoryWindow::InventoryWindow(), KillStats::KillStats(), MailEditWindow::MailEditWindow(), MailViewWindow::MailViewWindow(), MailWindow::MailWindow(), Minimap::Minimap(), NpcDialog::NpcDialog(), OutfitWindow::OutfitWindow(), SellDialog::postInit(), LoginDialog::postInit(), SocialWindow::postInit(), TextSelectDialog::postInit(), WhoIsOnline::postInit(), QuestsWindow::QuestsWindow(), EquipmentWindow::recalcSize(), ServerDialog::ServerDialog(), ServerInfoWindow::ServerInfoWindow(), Minimap::setMap(), ShopWindow::ShopWindow(), ShortcutWindow::ShortcutWindow(), SkillDialog::SkillDialog(), StatusWindow::StatusWindow(), TextCommandEditor::TextCommandEditor(), TradeWindow::TradeWindow(), and UpdaterWindow::UpdaterWindow().

◆ setDefaultSize() [2/3]

void Window::setDefaultSize	(	const int	defaultWidth,
		const int	defaultHeight,
		const ImagePosition::Type &	position,
		const int	offsetx,
		const int	offsetY
	)

Set the default win pos and size. (which can be different of the actual ones.) This version of setDefaultSize sets the window's position based on a relative enumerated position, rather than a coordinate position.

Definition at line 1206 of file window.cpp.

 {
     int x = 0;
     int y = 0;
  
     if (position == ImagePosition::UPPER_LEFT)
     {
     }
     else if (position == ImagePosition::UPPER_CENTER)
     {
         x = (mainGraphics->mWidth - defaultWidth) / 2;
     }
     else if (position == ImagePosition::UPPER_RIGHT)
     {
         x = mainGraphics->mWidth - defaultWidth;
     }
     else if (position == ImagePosition::LEFT)
     {
         y = (mainGraphics->mHeight - defaultHeight) / 2;
     }
     else if (position == ImagePosition::CENTER)
     {
         x = (mainGraphics->mWidth - defaultWidth) / 2;
         y = (mainGraphics->mHeight - defaultHeight) / 2;
     }
     else if (position == ImagePosition::RIGHT)
     {
         x = mainGraphics->mWidth - defaultWidth;
         y = (mainGraphics->mHeight - defaultHeight) / 2;
     }
     else if (position == ImagePosition::LOWER_LEFT)
     {
         y = mainGraphics->mHeight - defaultHeight;
     }
     else if (position == ImagePosition::LOWER_CENTER)
     {
         x = (mainGraphics->mWidth - defaultWidth) / 2;
         y = mainGraphics->mHeight - defaultHeight;
     }
     else if (position == ImagePosition::LOWER_RIGHT)
     {
         x = mainGraphics->mWidth - defaultWidth;
         y = mainGraphics->mHeight - defaultHeight;
     }
  
     mDefaultX = x - offsetX;
     mDefaultY = y - offsetY;
     mDefaultWidth = defaultWidth;
     mDefaultHeight = defaultHeight;
 }

References ImagePosition::CENTER, ImagePosition::LEFT, ImagePosition::LOWER_CENTER, ImagePosition::LOWER_LEFT, ImagePosition::LOWER_RIGHT, mainGraphics, mDefaultHeight, mDefaultWidth, mDefaultX, mDefaultY, Graphics::mHeight, Graphics::mWidth, ImagePosition::RIGHT, ImagePosition::UPPER_CENTER, ImagePosition::UPPER_LEFT, ImagePosition::UPPER_RIGHT, x, and y.

◆ setDefaultSize() [3/3]

void Window::setDefaultSize	(	const int	defaultX,
		const int	defaultY,
		int	defaultWidth,
		int	defaultHeight
	)

Set the default win pos and size. (which can be different of the actual ones.)

Definition at line 1180 of file window.cpp.

 {
     if (mMinWinWidth > defaultWidth)
         defaultWidth = mMinWinWidth;
     else if (mMaxWinWidth < defaultWidth)
         defaultWidth = mMaxWinWidth;
     if (mMinWinHeight > defaultHeight)
         defaultHeight = mMinWinHeight;
     else if (mMaxWinHeight < defaultHeight)
         defaultHeight = mMaxWinHeight;
  
     mDefaultX = defaultX;
     mDefaultY = defaultY;
     mDefaultWidth = defaultWidth;
     mDefaultHeight = defaultHeight;
 }

References mDefaultHeight, mDefaultWidth, mDefaultX, mDefaultY, mMaxWinHeight, mMaxWinWidth, mMinWinHeight, and mMinWinWidth.

◆ setDefaultVisible()

void Window::setDefaultVisible ( const bool save )

inline

Sets whether the window is visible by default.

Definition at line 288 of file window.h.

289 { mDefaultVisible = save; }

References mDefaultVisible.

Referenced by ChatWindow::ChatWindow(), CutInWindow::CutInWindow(), Minimap::Minimap(), and ShortcutWindow::ShortcutWindow().

◆ setLocationHorisontallyRelativeTo()

void Window::setLocationHorisontallyRelativeTo ( const Widget *const widget )

Sets the location relative to the given widget (only horisontally)

Definition at line 528 of file window.cpp.

 {
     if (widget == nullptr)
         return;
  
     int wx;
     int wy;
     int x;
     int y;
  
     widget->getAbsolutePosition(wx, wy);
     getAbsolutePosition(x, y);
  
     setPosition(mDimension.x + (wx + (widget->getWidth()
         - mDimension.width) / 2 - x), 0);
 }

References Widget::getAbsolutePosition(), Widget::getWidth(), Widget::mDimension, Widget::setPosition(), Rect::width, Rect::x, x, and y.

Referenced by centerHorisontally().

◆ setLocationRelativeTo() [1/2]

void Window::setLocationRelativeTo	(	const ImagePosition::Type &	position,
		int	offsetX,
		int	offsetY
	)

Sets the location relative to the given enumerated position.

Definition at line 545 of file window.cpp.

 {
     if (position == ImagePosition::UPPER_LEFT)
     {
     }
     else if (position == ImagePosition::UPPER_CENTER)
     {
         offsetX += (mainGraphics->mWidth - mDimension.width) / 2;
     }
     else if (position == ImagePosition::UPPER_RIGHT)
     {
         offsetX += mainGraphics->mWidth - mDimension.width;
     }
     else if (position == ImagePosition::LEFT)
     {
         offsetY += (mainGraphics->mHeight - mDimension.height) / 2;
     }
     else if (position == ImagePosition::CENTER)
     {
         offsetX += (mainGraphics->mWidth - mDimension.width) / 2;
         offsetY += (mainGraphics->mHeight - mDimension.height) / 2;
     }
     else if (position == ImagePosition::RIGHT)
     {
         offsetX += mainGraphics->mWidth - mDimension.width;
         offsetY += (mainGraphics->mHeight - mDimension.height) / 2;
     }
     else if (position == ImagePosition::LOWER_LEFT)
     {
         offsetY += mainGraphics->mHeight - mDimension.height;
     }
     else if (position == ImagePosition::LOWER_CENTER)
     {
         offsetX += (mainGraphics->mWidth - mDimension.width) / 2;
         offsetY += mainGraphics->mHeight - mDimension.height;
     }
     else if (position == ImagePosition::LOWER_RIGHT)
     {
         offsetX += mainGraphics->mWidth - mDimension.width;
         offsetY += mainGraphics->mHeight - mDimension.height;
     }
  
     setPosition(offsetX, offsetY);
 }

References ImagePosition::CENTER, Rect::height, ImagePosition::LEFT, ImagePosition::LOWER_CENTER, ImagePosition::LOWER_LEFT, ImagePosition::LOWER_RIGHT, mainGraphics, Widget::mDimension, Graphics::mHeight, Graphics::mWidth, ImagePosition::RIGHT, Widget::setPosition(), ImagePosition::UPPER_CENTER, ImagePosition::UPPER_LEFT, ImagePosition::UPPER_RIGHT, and Rect::width.

◆ setLocationRelativeTo() [2/2]

void Window::setLocationRelativeTo ( const Widget *const widget )

Sets the location relative to the given widget.

Definition at line 509 of file window.cpp.

 {
     if (widget == nullptr)
         return;
  
     int wx;
     int wy;
     int x;
     int y;
  
     widget->getAbsolutePosition(wx, wy);
     getAbsolutePosition(x, y);
  
     setPosition(mDimension.x + (wx + (widget->getWidth()
         - mDimension.width) / 2 - x),
         mDimension.y + (wy + (widget->getHeight()
         - mDimension.height) / 2 - y));
 }

References Widget::getAbsolutePosition(), Widget::getHeight(), Widget::getWidth(), Rect::height, Widget::mDimension, Widget::setPosition(), Rect::width, Rect::x, x, Rect::y, and y.

Referenced by center(), EditServerDialog::EditServerDialog(), ItemAmountWindow::ItemAmountWindow(), PincodeDialog::postInit(), QuitDialog::postInit(), SkillDialog::postInit(), TextDialog::postInit(), and WhoIsOnline::postInit().

◆ setMaxHeight()

void Window::setMaxHeight ( const int height )

Sets the minimum height of the window.

Definition at line 622 of file window.cpp.

 {
     mMaxWinHeight = height;
 }

References mMaxWinHeight.

Referenced by Minimap::setMap(), and ShortcutWindow::ShortcutWindow().

◆ setMaxWidth()

void Window::setMaxWidth ( const int width )

Sets the maximum width of the window.

Definition at line 617 of file window.cpp.

 {
     mMaxWinWidth = width;
 }

References mMaxWinWidth.

Referenced by Minimap::setMap(), and ShortcutWindow::ShortcutWindow().

◆ setMinHeight()

void Window::setMinHeight ( const int height )

Sets the minimum height of the window.

Definition at line 604 of file window.cpp.

 {
     if (mSkin != nullptr)
     {
         mMinWinHeight = height > mSkin->getMinHeight()
             ? height : mSkin->getMinHeight();
     }
     else
     {
         mMinWinHeight = height;
     }
 }

References Skin::getMinHeight(), mMinWinHeight, and mSkin.

Referenced by ChatWindow::ChatWindow(), DidYouKnowWindow::DidYouKnowWindow(), EditServerDialog::EditServerDialog(), HelpWindow::HelpWindow(), BuyDialog::init(), InventoryWindow::InventoryWindow(), MailEditWindow::MailEditWindow(), MailViewWindow::MailViewWindow(), MailWindow::MailWindow(), NpcDialog::NpcDialog(), OutfitWindow::OutfitWindow(), SellDialog::postInit(), SetupWindow::postInit(), SocialWindow::postInit(), TextSelectDialog::postInit(), QuestsWindow::QuestsWindow(), ServerDialog::ServerDialog(), ServerInfoWindow::ServerInfoWindow(), Minimap::setMap(), ShopWindow::ShopWindow(), ShortcutWindow::ShortcutWindow(), TradeWindow::TradeWindow(), and UpdaterWindow::UpdaterWindow().

◆ setMinWidth()

void Window::setMinWidth ( const int width )

Sets the minimum width of the window.

Definition at line 591 of file window.cpp.

 {
     if (mSkin != nullptr)
     {
         mMinWinWidth = width > mSkin->getMinWidth()
             ? width : mSkin->getMinWidth();
     }
     else
     {
         mMinWinWidth = width;
     }
 }

References Skin::getMinWidth(), mMinWinWidth, and mSkin.

Referenced by ChatWindow::ChatWindow(), ConnectionDialog::ConnectionDialog(), DidYouKnowWindow::DidYouKnowWindow(), EditServerDialog::EditServerDialog(), HelpWindow::HelpWindow(), BuyDialog::init(), InventoryWindow::InventoryWindow(), MailEditWindow::MailEditWindow(), MailViewWindow::MailViewWindow(), MailWindow::MailWindow(), NpcDialog::NpcDialog(), OutfitWindow::OutfitWindow(), SellDialog::postInit(), SetupWindow::postInit(), SocialWindow::postInit(), TextSelectDialog::postInit(), QuestsWindow::QuestsWindow(), ServerDialog::ServerDialog(), ServerInfoWindow::ServerInfoWindow(), Minimap::setMap(), ShopWindow::ShopWindow(), ShortcutWindow::ShortcutWindow(), TradeWindow::TradeWindow(), and UpdaterWindow::UpdaterWindow().

◆ setModal()

void Window::setModal ( const Modal modal )

Allows the windows modal status to change

Definition at line 1069 of file window.cpp.

 {
     if (mModal != modal)
     {
         mModal = modal;
         if (mModal == Modal_true)
         {
             if (gui != nullptr)
                 gui->setCursorType(Cursor::CURSOR_POINTER);
             requestModalFocus();
         }
         else
         {
             releaseModalFocus();
         }
     }
 }

References Cursor::CURSOR_POINTER, gui, mModal, Modal_true, Widget::releaseModalFocus(), Widget::requestModalFocus(), and Gui::setCursorType().

Referenced by SkillDialog::useSkillDefault(), SkillDialog::useSkillPosition(), and SkillDialog::useSkillTarget().

◆ setMovable()

void Window::setMovable ( Move movable )

inline

Sets the window to be moveble or not.

Parameters

movable True if the window should be movable, false otherwise.

See also: isMovable

Definition at line 567 of file window.h.

568 { mMovable = movable; }

References mMovable.

Referenced by ConnectionDialog::ConnectionDialog().

◆ setPadding()

void Window::setPadding ( int padding )

inline

Sets the padding of the window. The padding is the distance between the window border and the content.

Parameters

padding The padding of the window.

See also: getPadding

Definition at line 494 of file window.h.

495 { mPadding = padding; }

References mPadding.

Referenced by Window().

◆ setResizable()

void Window::setResizable ( const bool resize )

Sets whether or not the window can be resized.

Definition at line 627 of file window.cpp.

 {
     if ((mGrip != nullptr) == r)
         return;
  
     if (mGrip != nullptr)
         mGrip->decRef();
     if (r)
     {
         mGrip = Theme::getImageFromThemeXml("resize.xml", "");
         if (mGrip != nullptr)
         {
             mGripRect.x = mDimension.width - mGrip->getWidth() - mGripPadding;
             mGripRect.y = mDimension.height - mGrip->getHeight()
                 - mGripPadding;
         }
         else
         {
             mGripRect.x = 0;
             mGripRect.y = 0;
         }
     }
     else
     {
         mGrip = nullptr;
     }
 }

References Theme::getImageFromThemeXml(), Rect::height, Widget::mDimension, mGrip, mGripPadding, mGripRect, Rect::width, Rect::x, and Rect::y.

Referenced by ChatWindow::ChatWindow(), ClanWindow::ClanWindow(), CutInWindow::CutInWindow(), DebugWindow::DebugWindow(), DidYouKnowWindow::DidYouKnowWindow(), EditServerDialog::EditServerDialog(), EmoteWindow::EmoteWindow(), HelpWindow::HelpWindow(), BuyDialog::init(), InventoryWindow::InventoryWindow(), KillStats::KillStats(), MailEditWindow::MailEditWindow(), MailViewWindow::MailViewWindow(), MailWindow::MailWindow(), Minimap::Minimap(), NpcDialog::NpcDialog(), OutfitWindow::OutfitWindow(), SellDialog::postInit(), SocialWindow::postInit(), TextSelectDialog::postInit(), WhoIsOnline::postInit(), QuestsWindow::QuestsWindow(), ServerDialog::ServerDialog(), ServerInfoWindow::ServerInfoWindow(), SetupWindow::SetupWindow(), ShopWindow::ShopWindow(), ShortcutWindow::ShortcutWindow(), SkillDialog::SkillDialog(), StatusWindow::StatusWindow(), TradeWindow::TradeWindow(), and UpdaterWindow::UpdaterWindow().

◆ setSaveVisible()

void Window::setSaveVisible ( const bool save )

inline

Sets whether the window will save it's visibility.

Definition at line 300 of file window.h.

301 { mSaveVisible = save; }

References mSaveVisible.

Referenced by ChatWindow::ChatWindow(), ClanWindow::ClanWindow(), CutInWindow::CutInWindow(), DebugWindow::DebugWindow(), EquipmentWindow::EquipmentWindow(), InventoryWindow::InventoryWindow(), KillStats::KillStats(), MailEditWindow::MailEditWindow(), MailViewWindow::MailViewWindow(), MailWindow::MailWindow(), Minimap::Minimap(), SocialWindow::postInit(), WhoIsOnline::postInit(), QuestsWindow::QuestsWindow(), ShortcutWindow::ShortcutWindow(), SkillDialog::SkillDialog(), and StatusWindow::StatusWindow().

◆ setShowTitle()

void Window::setShowTitle ( bool flag )

inline

Sets flag to show a title or not.

Definition at line 235 of file window.h.

236 { mShowTitle = flag; }

References mShowTitle.

Referenced by ChatWindow::ChatWindow(), CutInWindow::CutInWindow(), EmoteWindow::EmoteWindow(), ShortcutWindow::ShortcutWindow(), and CutInWindow::show().

◆ setSticky()

void Window::setSticky ( const bool sticky )

Sets whether the window is sticky. A sticky window will not have its visibility set to false on a general setVisible(false) call. Use this to set the default before you call loadWindowState().

Definition at line 766 of file window.cpp.

 {
     mSticky = sticky;
     mRedraw = true;
 }

References Widget::mRedraw, and mSticky.

Referenced by CharCreateDialog::CharCreateDialog(), PopupMenu::handleLink(), loadWindowState(), Minimap::Minimap(), and mousePressed().

◆ setStickyButton()

void Window::setStickyButton ( const bool flag )

Sets whether or not the window has a sticky button.

Definition at line 761 of file window.cpp.

 {
     mStickyButton = flag;
 }

References mStickyButton.

Referenced by Minimap::Minimap().

◆ setStickyButtonLock()

void Window::setStickyButtonLock ( const bool sticky )

Sets whether the window sticky mean window locked or not.

Definition at line 772 of file window.cpp.

 {
     mStickyButtonLock = lock;
     mStickyButton = lock;
 }

References mStickyButton, and mStickyButtonLock.

Referenced by CharCreateDialog::CharCreateDialog(), ChatWindow::ChatWindow(), ClanWindow::ClanWindow(), DebugWindow::DebugWindow(), DidYouKnowWindow::DidYouKnowWindow(), EquipmentWindow::EquipmentWindow(), HelpWindow::HelpWindow(), BuyDialog::init(), InventoryWindow::InventoryWindow(), KillStats::KillStats(), MailEditWindow::MailEditWindow(), MailViewWindow::MailViewWindow(), MailWindow::MailWindow(), NpcDialog::NpcDialog(), OutfitWindow::OutfitWindow(), PincodeDialog::PincodeDialog(), SellDialog::postInit(), SocialWindow::postInit(), TextSelectDialog::postInit(), WhoIsOnline::postInit(), QuestsWindow::QuestsWindow(), ServerInfoWindow::ServerInfoWindow(), SetupWindow::SetupWindow(), ShopWindow::ShopWindow(), SkillDialog::SkillDialog(), StatusWindow::StatusWindow(), and TradeWindow::TradeWindow().

◆ setTitleBarHeight()

void Window::setTitleBarHeight ( unsigned int height )

inline

Sets the title bar height.

Parameters

height The title height value.

See also: getTitleBarHeight

Definition at line 513 of file window.h.

514 { mTitleBarHeight = height; }

References mTitleBarHeight.

Referenced by ChatWindow::ChatWindow(), EmoteWindow::postInit(), ShortcutWindow::ShortcutWindow(), and Window().

◆ setTitlePadding()

void Window::setTitlePadding ( const int p )

inlineprotected

Definition at line 599 of file window.h.

600 { mTitlePadding = p; }

References mTitlePadding.

◆ setVisible() [1/2]

void Window::setVisible	(	const Visible	visible,
		const bool	forceSticky
	)

Overloads window setVisible by Guichan to allow sticky window handling, or not, if you force the sticky state.

Definition at line 783 of file window.cpp.

 {
     if (visible == mVisible)
         return;
  
     // Check if the window is off screen...
     if (visible == Visible_true)
         ensureOnScreen();
     else
         mResizeHandles = 0;
  
     if (mStickyButtonLock)
     {
         BasicContainer2::setVisible(visible);
     }
     else
     {
         BasicContainer2::setVisible(fromBool((!forceSticky && mSticky) ||
             visible == Visible_true, Visible));
     }
     if (visible == Visible_true)
     {
         if (mPlayVisibleSound)
             soundManager.playGuiSound(SOUND_SHOW_WINDOW);
         if (gui != nullptr)
         {
             MouseEvent *const event = reinterpret_cast<MouseEvent*>(
                 gui->createMouseEvent(this));
             if (event != nullptr)
             {
                 const int x = event->getX();
                 const int y = event->getY();
                 if (x >= 0 && x <= mDimension.width
                     && y >= 0 && y <= mDimension.height)
                 {
                     mouseMoved(*event);
                 }
                 delete event;
             }
         }
     }
     else
     {
         if (mPlayVisibleSound)
             soundManager.playGuiSound(SOUND_HIDE_WINDOW);
     }
 }

References Gui::createMouseEvent(), ensureOnScreen(), fromBool, gui, Rect::height, Widget::mDimension, mouseMoved(), mPlayVisibleSound, mResizeHandles, mSticky, mStickyButtonLock, Widget::mVisible, SoundManager::playGuiSound(), Widget::setVisible(), SOUND_HIDE_WINDOW, SOUND_SHOW_WINDOW, soundManager, Visible_true, Rect::width, x, and y.

◆ setVisible() [2/2]

void Window::setVisible ( Visible visible )

virtual

Overloads window setVisible by Guichan to allow sticky window handling.

Reimplemented in TextSelectDialog, ShopWindow, SetupWindow, NpcDialog, InventoryWindow, DidYouKnowWindow, ChatWindow, BuySellDialog, BuyDialog, and SellDialog.

Definition at line 778 of file window.cpp.

 {
     setVisible(visible, false);
 }

◆ setWindowContainer()

void Window::setWindowContainer ( WindowContainer *const windowContainer )

static

Sets the window container to be used by new windows.

Definition at line 306 of file window.cpp.

 {
     windowContainer = wc;
 }

References windowContainer.

Referenced by Gui::postInit(), and Gui::~Gui().

◆ setWindowName()

void Window::setWindowName ( const std::string & name )

inline

Sets the name of the window. This is not the window title.

Definition at line 355 of file window.h.

356 { mWindowName = name; }

References mWindowName.

Referenced by BankWindow::BankWindow(), CharCreateDialog::CharCreateDialog(), ChatWindow::ChatWindow(), ClanWindow::ClanWindow(), CutInWindow::CutInWindow(), DebugWindow::DebugWindow(), DidYouKnowWindow::DidYouKnowWindow(), EditServerDialog::EditServerDialog(), EggSelectionDialog::EggSelectionDialog(), EquipmentWindow::EquipmentWindow(), HelpWindow::HelpWindow(), BuyDialog::init(), BuySellDialog::init(), InsertCardDialog::InsertCardDialog(), InventoryWindow::InventoryWindow(), KillStats::KillStats(), LoginDialog::LoginDialog(), MailEditWindow::MailEditWindow(), MailViewWindow::MailViewWindow(), MailWindow::MailWindow(), Minimap::Minimap(), NpcDialog::NpcDialog(), OutfitWindow::OutfitWindow(), SellDialog::postInit(), SocialWindow::postInit(), TextSelectDialog::postInit(), QuestsWindow::QuestsWindow(), ServerDialog::ServerDialog(), ServerInfoWindow::ServerInfoWindow(), ShopWindow::ShopWindow(), ShortcutWindow::ShortcutWindow(), SkillDialog::SkillDialog(), StatusWindow::StatusWindow(), TextCommandEditor::TextCommandEditor(), TradeWindow::TradeWindow(), UpdaterWindow::UpdaterWindow(), and WhoIsOnline::WhoIsOnline().

◆ updateResizeHandler()

void Window::updateResizeHandler ( MouseEvent & event )

Definition at line 930 of file window.cpp.

 {
     if (gui == nullptr)
         return;
  
 #ifndef DYECMD
     if (!dragDrop.isEmpty())
         return;
 #endif  // DYECMD
  
     mResizeHandles = getResizeHandles(event);
  
     // Changes the custom mouse cursor based on it's current position.
     switch (mResizeHandles & resizeMask)
     {
         case BOTTOM | RIGHT:
         case TOP | LEFT:
             gui->setCursorType(Cursor::CURSOR_RESIZE_DOWN_RIGHT);
             break;
         case TOP | RIGHT:
         case BOTTOM | LEFT:
             gui->setCursorType(Cursor::CURSOR_RESIZE_DOWN_LEFT);
             break;
         case BOTTOM:
         case TOP:
             gui->setCursorType(Cursor::CURSOR_RESIZE_DOWN);
             break;
         case RIGHT:
         case LEFT:
             gui->setCursorType(Cursor::CURSOR_RESIZE_ACROSS);
             break;
         default:
             gui->setCursorType(Cursor::CURSOR_POINTER);
             break;
     }
 }

References BOTTOM, Cursor::CURSOR_POINTER, Cursor::CURSOR_RESIZE_ACROSS, Cursor::CURSOR_RESIZE_DOWN, Cursor::CURSOR_RESIZE_DOWN_LEFT, Cursor::CURSOR_RESIZE_DOWN_RIGHT, dragDrop, getResizeHandles(), gui, DragDrop::isEmpty(), LEFT, mResizeHandles, resizeMask, RIGHT, Gui::setCursorType(), and TOP.

Referenced by mouseEntered(), and mouseMoved().

◆ widgetHidden()

void Window::widgetHidden ( const Event & event )

virtual

Called whenever the widget is hidden.

Reimplemented from WidgetListener.

Reimplemented in ShortcutWindow, and InventoryWindow.

Definition at line 725 of file window.cpp.

 {
     if (isBatchDrawRenders(openGLMode))
         mVertexes->clear();
  
     mTextChunk.deleteImage();
  
     mTextChanged = true;
     mRedraw = true;
  
     if (gui != nullptr)
         gui->setCursorType(Cursor::CURSOR_POINTER);
  
     if (mFocusHandler == nullptr)
         return;
  
     for (WidgetListConstIterator it = mWidgets.begin();
          it != mWidgets.end(); ++ it)
     {
         if (mFocusHandler->isFocused(*it))
             mFocusHandler->focusNone();
     }
 }

References ImageCollection::clear(), Cursor::CURSOR_POINTER, TextChunk::deleteImage(), FocusHandler::focusNone(), gui, isBatchDrawRenders, FocusHandler::isFocused(), Widget::mFocusHandler, Widget::mRedraw, mTextChanged, mTextChunk, mVertexes, BasicContainer::mWidgets, openGLMode, and Gui::setCursorType().

Referenced by InventoryWindow::widgetHidden(), and ShortcutWindow::widgetHidden().

◆ widgetMoved()

void Window::widgetMoved ( const Event & event )

virtual

Invoked when a widget is moved.

Parameters

event Describes the event.

Reimplemented from WidgetListener.

Reimplemented in ShortcutWindow, and EmoteWindow.

Definition at line 720 of file window.cpp.

 {
     mRedraw = true;
 }

References Widget::mRedraw.

Referenced by EmoteWindow::widgetMoved(), and ShortcutWindow::widgetMoved().

◆ widgetResized()

void Window::widgetResized ( const Event & event )

virtual

Called whenever the widget changes size.

Reimplemented from WidgetListener.

Reimplemented in WhoIsOnline, SocialWindow, SkillDialog, SetupWindow, InventoryWindow, EmoteWindow, DebugWindow, ClanWindow, ChatWindow, and CharSelectDialog.

Definition at line 655 of file window.cpp.

 {
     if (mGrip != nullptr)
     {
         mGripRect.x = mDimension.width - mGrip->getWidth() - mGripPadding;
         mGripRect.y = mDimension.height - mGrip->getHeight() - mGripPadding;
     }
  
     if (mLayout != nullptr)
     {
         const Rect area = getChildrenArea();
         int w = area.width;
         int h = area.height;
         mLayout->reflow(w, h);
     }
     if (mSkin != nullptr)
     {
         const bool showClose = mCloseWindowButton
             && (mSkin->getCloseImage(false) != nullptr);
         if (showClose)
         {
             const Image *const button = mSkin->getCloseImage(false);
             if (button != nullptr)
             {
                 const int buttonWidth = button->getWidth();
                 mCloseRect.x = mDimension.width - buttonWidth - mClosePadding;
                 mCloseRect.y = mClosePadding;
                 mCloseRect.width = buttonWidth;
                 mCloseRect.height = button->getHeight();
             }
         }
         if (mStickyButton)
         {
             const Image *const button = mSkin->getStickyImage(mSticky);
             if (button != nullptr)
             {
                 const int buttonWidth = button->getWidth();
                 int x = mDimension.width - buttonWidth
                     - mStickySpacing - mClosePadding;
  
                 if (showClose)
                     x -= mSkin->getCloseImage(false)->getWidth();
  
                 mStickyRect.x = x;
                 mStickyRect.y = mStickyPadding;
                 mStickyRect.width = buttonWidth;
                 mStickyRect.height = button->getHeight();
             }
         }
     }
     else
     {
         mCloseRect.x = 0;
         mCloseRect.y = 0;
         mCloseRect.width = 0;
         mCloseRect.height = 0;
         mStickyRect.x = 0;
         mStickyRect.y = 0;
         mStickyRect.width = 0;
         mStickyRect.height = 0;
     }
  
     mRedraw = true;
 }

References buttonWidth, getChildrenArea(), Skin::getCloseImage(), Skin::getStickyImage(), Rect::height, mClosePadding, mCloseRect, mCloseWindowButton, Widget::mDimension, mGrip, mGripPadding, mGripRect, mLayout, Widget::mRedraw, mSkin, mSticky, mStickyButton, mStickyPadding, mStickyRect, mStickySpacing, Layout::reflow(), Rect::width, Rect::x, x, and Rect::y.

Referenced by ShortcutWindow::addButton(), adjustSizeToScreen(), HelpWindow::HelpWindow(), DidYouKnowWindow::postInit(), ServerInfoWindow::ServerInfoWindow(), CharSelectDialog::widgetResized(), ChatWindow::widgetResized(), ClanWindow::widgetResized(), DebugWindow::widgetResized(), EmoteWindow::widgetResized(), InventoryWindow::widgetResized(), SetupWindow::widgetResized(), SkillDialog::widgetResized(), SocialWindow::widgetResized(), and WhoIsOnline::widgetResized().

◆ willSaveVisible()

bool Window::willSaveVisible ( ) const

inline

Returns whether the window will save it's visibility.

Definition at line 294 of file window.h.

295 { return mSaveVisible; }

References mSaveVisible.

Field Documentation

◆ mAlignment

Graphics::Alignment Window::mAlignment

protected

Holds the alignment of the caption.

Definition at line 613 of file window.h.

Referenced by getAlignment(), and setAlignment().

◆ mAllowClose

bool Window::mAllowClose

private

Definition at line 730 of file window.h.

Referenced by getAlowClose(), setAllowClose(), and setCloseButton().

◆ mCaption

std::string Window::mCaption

Image* Window::mGrip

private

Resize grip

Definition at line 687 of file window.h.

Referenced by adjustSizeToScreen(), draw(), getResizeHandles(), isResizable(), isResizeAllowed(), loadWindowState(), mouseExited(), mouseReleased(), safeDraw(), saveWindowState(), setResizable(), widgetResized(), and ~Window().

◆ mOldResizeHandles

int Window::mOldResizeHandles

private

Definition at line 715 of file window.h.

Referenced by draw().

◆ mouseResize

int Window::mouseResize = 0

staticprivate

Active resize handles

Definition at line 700 of file window.h.

Referenced by mouseDragged(), mouseExited(), mousePressed(), and mouseReleased().

◆ mPadding

int Window::mPadding

protected

◆ mParentWindow

Window* Window::mParentWindow

private

The parent window

Definition at line 688 of file window.h.

Referenced by getParentWindow().

◆ mPlayVisibleSound

bool Window::mPlayVisibleSound

private

Definition at line 727 of file window.h.

Referenced by enableVisibleSound(), and setVisible().

bool Window::mStickyButtonLock

private

Window locked if sticky enabled

Definition at line 726 of file window.h.

Referenced by canMove(), getResizeHandles(), isStickyButtonLock(), setStickyButtonLock(), and setVisible().

◆ mStickyPadding

int Window::mStickyPadding

private

Definition at line 718 of file window.h.

Referenced by widgetResized(), and Window().

◆ mStickyRect

Rect Window::mStickyRect

private

Sticky button rectangle

Definition at line 691 of file window.h.

Referenced by draw(), mousePressed(), safeDraw(), and widgetResized().

◆ mStickySpacing

int Window::mStickySpacing

private

Definition at line 717 of file window.h.

Referenced by widgetResized(), and Window().

◆ mTextChanged

bool Window::mTextChanged

private

Definition at line 729 of file window.h.

Referenced by draw(), safeDraw(), setCaption(), and widgetHidden().

◆ windowInstances

int Window::windowInstances = 0

staticprivate

Number of Window instances

Definition at line 701 of file window.h.

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

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

src/gui/widgets/window.h (986a3bf)
src/gui/widgets/window.cpp (986a3bf)

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ResizeHandles

Constructor & Destructor Documentation

◆ Window()

◆ ~Window()

Member Function Documentation

◆ adjustPositionAfterResize()

◆ adjustSizeToScreen()

◆ canMove()

◆ center()

◆ centerHorisontally()

◆ clearLayout()

◆ close()

◆ draw()

◆ enableVisibleSound()

◆ ensureOnScreen()

◆ getAlignment()

◆ getAlowClose()

◆ getCaption()

◆ getChildrenArea()

◆ getCloseButton()

◆ getLayout()

◆ getMaxHeight()

◆ getMaxWidth()

◆ getMinHeight()

◆ getMinWidth()

◆ getOption()

◆ getOptionBool()

◆ getPadding()

◆ getParentWindow()

◆ getPlacer()

◆ getResizeHandles()

◆ getTitleBarHeight()

◆ getTitlePadding()

◆ getWindowArea()

◆ getWindowName()

◆ isDefaultVisible()

◆ isMovable()

◆ isResizable()

◆ isResizeAllowed()

◆ isSticky()

◆ isStickyButtonLock()

◆ isWindowVisible()

◆ loadWindowState()

◆ mouseDragged()

◆ mouseEntered()

◆ mouseExited()

◆ mouseMoved()

◆ mousePressed()

◆ mouseReleased()

◆ place()

◆ postInit()

◆ redraw()

◆ reflowLayout()

◆ resetToDefaultSize()

◆ resizeToContent()

◆ safeDraw()

◆ saveWindowState()

◆ scheduleDelete()

◆ setAlignment()

◆ setAllowClose()

◆ setCaption()

◆ setCaptionFont()

◆ setCloseButton()

◆ setContentSize()

◆ setDefaultSize() [1/3]

◆ setDefaultSize() [2/3]

◆ setDefaultSize() [3/3]

◆ setDefaultVisible()

◆ setLocationHorisontallyRelativeTo()