Skin Class Reference

#include <skin.h>

Public Member Functions
	Skin (ImageRect *const skin, const ImageRect *const images, const std::string &filePath, const std::string &name, const int padding, const int titlePadding, StringIntMap *const options)
	~Skin ()
const std::string &	getName () const
const std::string &	getFilePath () const
const ImageRect &	getBorder () const
const Image *	getCloseImage (const bool state) const
const Image *	getStickyImage (const bool state) const
int	getMinWidth () const
int	getMinHeight () const
void	updateAlpha (const float minimumOpacityAllowed)
int	getPadding () const
int	getTitlePadding () const
int	getOption (const std::string &name) const
int	getOption (const std::string &name, const int def) const

Data Fields
int	instances

Private Attributes
std::string	mFilePath
std::string	mName
ImageRect *	mBorder
Image *	mCloseImage
Image *	mCloseImageHighlighted
Image *	mStickyImageUp
Image *	mStickyImageDown
int	mPadding
int	mTitlePadding
StringIntMap *	mOptions

Detailed Description

Definition at line 36 of file skin.h.

Constructor & Destructor Documentation

Skin()

Skin::Skin	(	ImageRect *const	skin,
		const ImageRect *const	images,
		const std::string &	filePath,
		const std::string &	name,
		const int	padding,
		const int	titlePadding,
		StringIntMap *const	options
	)

Definition at line 40 of file skin.cpp.

                                                 :
    instances(1),
    mFilePath(filePath),
    mName(name),
    mBorder(skin),
    mCloseImage(images != nullptr ? images->grid[0] : nullptr),
    mCloseImageHighlighted(images != nullptr ? images->grid[1] : nullptr),
    mStickyImageUp(images != nullptr ? images->grid[2] : nullptr),
    mStickyImageDown(images != nullptr ? images->grid[3] : nullptr),
    mPadding(padding),
    mTitlePadding(titlePadding),
    mOptions(options)
{
    if (mCloseImageHighlighted == nullptr)
    {
        mCloseImageHighlighted = mCloseImage;
        if (mCloseImageHighlighted != nullptr)
            mCloseImageHighlighted->incRef();
    }
}

References mCloseImage, and mCloseImageHighlighted.

~Skin()

Skin::~Skin

(

)

Definition at line 65 of file skin.cpp.

{
    for (int i = 0; i < 9; i++)
    {
        if ((mBorder != nullptr) && (mBorder->grid[i] != nullptr))
        {
            mBorder->grid[i]->decRef();
            mBorder->grid[i] = nullptr;
        }
    }
 
    if (mCloseImage != nullptr)
    {
        mCloseImage->decRef();
        mCloseImage = nullptr;
    }
 
    if (mCloseImageHighlighted != nullptr)
    {
        mCloseImageHighlighted->decRef();
        mCloseImageHighlighted = nullptr;
    }
 
    if (mStickyImageUp != nullptr)
    {
        mStickyImageUp->decRef();
        mStickyImageUp = nullptr;
    }
 
    if (mStickyImageDown != nullptr)
    {
        mStickyImageDown->decRef();
        mStickyImageDown = nullptr;
    }
 
    delete2(mOptions)
    delete2(mBorder)
}

References delete2, ImageRect::grid, mBorder, mCloseImage, mCloseImageHighlighted, mOptions, mStickyImageDown, and mStickyImageUp.

Member Function Documentation

getBorder()

const ImageRect& Skin::getBorder ( ) const

inline

Returns the background skin.

Definition at line 68 of file skin.h.

        { return *mBorder; }

References mBorder.

Referenced by Button::draw(), Popup::draw(), ProgressBar::draw(), Tab::draw(), Window::draw(), CheckBox::drawBox(), RadioButton::drawBox(), DropDown::DropDown(), Theme::getImageFromThemeXml(), Theme::getImageSetFromThemeXml(), ScrollArea::init(), Button::safeDraw(), Popup::safeDraw(), ProgressBar::safeDraw(), Tab::safeDraw(), Window::safeDraw(), TestLauncher::testDraw(), Button::updateAlpha(), CheckBox::updateAlpha(), RadioButton::updateAlpha(), and Tab::updateAlpha().

getCloseImage()

const Image* Skin::getCloseImage ( const bool  state ) const

inline

Returns the image used by a close button for this skin.

Definition at line 74 of file skin.h.

        { return state ? mCloseImageHighlighted : mCloseImage; }

References mCloseImage, and mCloseImageHighlighted.

Referenced by Window::draw(), Window::safeDraw(), and Window::widgetResized().

getFilePath()

const std::string& Skin::getFilePath ( ) const

inline

Returns the skin's xml file path.

Definition at line 62 of file skin.h.

        { return mFilePath; }

References mFilePath.

getMinHeight()

int Skin::getMinHeight

(

)

const

Returns the minimum height which can be used with this skin.

Definition at line 142 of file skin.cpp.

{
    if ((mBorder == nullptr) ||
        (mBorder->grid[ImagePosition::UPPER_LEFT] == nullptr) ||
        (mBorder->grid[ImagePosition::LOWER_LEFT] == nullptr))
    {
        return 1;
    }
 
    return mBorder->grid[ImagePosition::UPPER_LEFT]->getHeight() +
           mBorder->grid[ImagePosition::LOWER_LEFT]->getHeight();
}

References ImageRect::grid, ImagePosition::LOWER_LEFT, mBorder, and ImagePosition::UPPER_LEFT.

Referenced by Popup::setMinHeight(), and Window::setMinHeight().

getMinWidth()

int Skin::getMinWidth

(

)

const

Returns the minimum width which can be used with this skin.

Definition at line 129 of file skin.cpp.

{
    if ((mBorder == nullptr) ||
        (mBorder->grid[ImagePosition::UPPER_LEFT] == nullptr) ||
        (mBorder->grid[ImagePosition::UPPER_RIGHT] == nullptr))
    {
        return 1;
    }
 
    return mBorder->grid[ImagePosition::UPPER_LEFT]->getWidth() +
           mBorder->grid[ImagePosition::UPPER_RIGHT]->getWidth();
}

References ImageRect::grid, mBorder, ImagePosition::UPPER_LEFT, and ImagePosition::UPPER_RIGHT.

Referenced by Popup::setMinWidth(), and Window::setMinWidth().

getName()

const std::string& Skin::getName ( ) const

inline

Returns the skin's name. Useful for giving a human friendly skin name if a dialog for skin selection for a specific window type is done.

Definition at line 56 of file skin.h.

        { return mName; }

References mName.

getOption() [1/2]

int Skin::getOption ( const std::string &  name ) const

inline

Definition at line 106 of file skin.h.

        {
            if (mOptions->find(name) != mOptions->end())
                return (*mOptions)[name];
            return 0;
        }

References mOptions.

Referenced by BrowserBox::BrowserBox(), CheckBox::CheckBox(), ColorPage::ColorPage(), Desktop::Desktop(), DropDown::DropDown(), Client::gameInit(), Window::getOption(), Window::getOptionBool(), Button::init(), PlayerBox::init(), ScrollArea::init(), ListBox::ListBox(), TouchManager::loadButtons(), TouchManager::loadTouchItem(), Pincode::Pincode(), Popup::Popup(), Desktop::postInit(), ProgressBar::ProgressBar(), RadioButton::RadioButton(), ItemShortcutContainer::setSkin(), ShortcutContainer::setSkin(), SkillRectangleListBox::SkillRectangleListBox(), StaticBrowserBox::StaticBrowserBox(), TextField::TextField(), TextPreview::TextPreview(), and WindowMenu::WindowMenu().

getOption() [2/2]

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

inline

Definition at line 113 of file skin.h.

        {
            if (mOptions->find(name) != mOptions->end())
                return (*mOptions)[name];
            return def;
        }

References mOptions.

getPadding()

int Skin::getPadding ( ) const

inline

Definition at line 100 of file skin.h.

        { return mPadding; }

References mPadding.

Referenced by Button::adjustSize(), Tab::adjustSize(), BrowserBox::BrowserBox(), CheckBox::CheckBox(), Button::draw(), Tab::draw(), DropDown::DropDown(), Client::gameInit(), Label::init(), Tab::init(), ListBox::ListBox(), TouchManager::loadButtons(), TouchManager::loadTouchItem(), Pincode::Pincode(), Popup::Popup(), ProgressBar::ProgressBar(), RadioButton::RadioButton(), Button::safeDraw(), Tab::safeDraw(), SkillRectangleListBox::SkillRectangleListBox(), StaticBrowserBox::StaticBrowserBox(), TextField::TextField(), and Window::Window().

getStickyImage()

const Image* Skin::getStickyImage ( const bool  state ) const

inline

Returns the image used by a sticky button for this skin.

Definition at line 81 of file skin.h.

        { return state ? mStickyImageDown : mStickyImageUp; }

References mStickyImageDown, and mStickyImageUp.

Referenced by Window::draw(), Window::safeDraw(), and Window::widgetResized().

getTitlePadding()

int Skin::getTitlePadding ( ) const

inline

Definition at line 103 of file skin.h.

        { return mTitlePadding; }

References mTitlePadding.

Referenced by Window::Window().

updateAlpha()

void Skin::updateAlpha

(

const float

minimumOpacityAllowed

)

Updates the alpha value of the skin

Definition at line 104 of file skin.cpp.

{
    const float alpha = static_cast<float>(
        std::max(static_cast<double>(minimumOpacityAllowed),
        static_cast<double>(settings.guiAlpha)));
 
    if (mBorder != nullptr)
    {
        for (int i = 0; i < 9; i++)
        {
            if (mBorder->grid[i] != nullptr)
                mBorder->grid[i]->setAlpha(alpha);
        }
    }
 
    if (mCloseImage != nullptr)
        mCloseImage->setAlpha(alpha);
    if (mCloseImageHighlighted != nullptr)
        mCloseImageHighlighted->setAlpha(alpha);
    if (mStickyImageUp != nullptr)
        mStickyImageUp->setAlpha(alpha);
    if (mStickyImageDown != nullptr)
        mStickyImageDown->setAlpha(alpha);
}

References ImageRect::grid, Settings::guiAlpha, mBorder, mCloseImage, mCloseImageHighlighted, mStickyImageDown, mStickyImageUp, and settings.

Referenced by Theme::readSkin(), and Theme::updateAlpha().

Field Documentation

instances

int Skin::instances

Definition at line 121 of file skin.h.

Referenced by Theme::unload().

mBorder

ImageRect* Skin::mBorder

private

The window border and background

Definition at line 126 of file skin.h.

Referenced by getBorder(), getMinHeight(), getMinWidth(), updateAlpha(), and ~Skin().

mCloseImage

Image* Skin::mCloseImage

private

Close Button Image

Definition at line 127 of file skin.h.

Referenced by getCloseImage(), Skin(), updateAlpha(), and ~Skin().

mCloseImageHighlighted

Image* Skin::mCloseImageHighlighted

private

Highlighted close Button Image

Definition at line 128 of file skin.h.

Referenced by getCloseImage(), Skin(), updateAlpha(), and ~Skin().

mFilePath

std::string Skin::mFilePath

private

File name path for the skin

Definition at line 124 of file skin.h.

Referenced by getFilePath().

mName

std::string Skin::mName

private

Name of the skin to use

Definition at line 125 of file skin.h.

Referenced by getName().

mOptions

StringIntMap* Skin::mOptions

private

Definition at line 133 of file skin.h.

Referenced by getOption(), and ~Skin().

mPadding

int Skin::mPadding

private

Definition at line 131 of file skin.h.

Referenced by getPadding().

mStickyImageDown

Image* Skin::mStickyImageDown

private

Sticky Button Image

Definition at line 130 of file skin.h.

Referenced by getStickyImage(), updateAlpha(), and ~Skin().

mStickyImageUp

Image* Skin::mStickyImageUp

private

Sticky Button Image

Definition at line 129 of file skin.h.

Referenced by getStickyImage(), updateAlpha(), and ~Skin().

mTitlePadding

int Skin::mTitlePadding

private

Definition at line 132 of file skin.h.

Referenced by getTitlePadding().

---

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

• src/gui/skin.h (986a3bf)
• src/gui/skin.cpp (986a3bf)