ShortcutBase Class Reference

#include <shortcutbase.h>

Inheritance diagram for ShortcutBase:

Public Member Functions
	ShortcutBase (const std::string &itemName, const std::string &colorName, const int maxSize)
virtual	~ShortcutBase ()
void	load ()
void	save () const
int	getItem (const size_t index) const
ItemColor	getItemColor (const size_t index) const
int	getItemCount () const
int	getItemSelected () const
void	setItem (const size_t index)
void	setItems (const size_t index, const int itemId, const ItemColor color)
void	setItemSelected (const int itemId)
void	setItemSelected (const Item *const item)
bool	isItemSelected () const
void	removeItem (const size_t index)
void	clear (const bool isSave)

Private Attributes
int *	mItems
ItemColor *	mItemColors
std::string	mItemName
std::string	mColorName
size_t	mMaxSize
int	mItemSelected
ItemColor	mItemColorSelected

Detailed Description

The class which keeps track of the item shortcuts.

Definition at line 39 of file shortcutbase.h.

Constructor & Destructor Documentation

ShortcutBase()

ShortcutBase::ShortcutBase	(	const std::string &	itemName,
		const std::string &	colorName,
		const int	maxSize
	)

Constructor.

Definition at line 31 of file shortcutbase.cpp.

                                              :
    mItems(new int[maxSize]),
    mItemColors(new ItemColor[maxSize]),
    mItemName(itemName),
    mColorName(colorName),
    mMaxSize(maxSize),
    mItemSelected(-1),
    mItemColorSelected(ItemColor_one)
{
    clear(false);
    load();
}

References clear(), and load().

~ShortcutBase()

ShortcutBase::~ShortcutBase ( )

virtual

Destructor.

Definition at line 46 of file shortcutbase.cpp.

{
    delete [] mItems;
    mItems = nullptr;
    delete [] mItemColors;
    mItemColors = nullptr;
}

References mItemColors, and mItems.

Member Function Documentation

clear()

void ShortcutBase::clear

(

const bool

isSave

)

Definition at line 119 of file shortcutbase.cpp.

{
    for (size_t i = 0; i < mMaxSize; i++)
    {
        mItems[i] = -1;
        mItemColors[i] = ItemColor_one;
    }
    if (isSave)
        save();
}

References ItemColor_one, mItemColors, mItems, mMaxSize, and save().

Referenced by DropShortcut::DropShortcut(), and ShortcutBase().

getItem()

int ShortcutBase::getItem ( const size_t  index ) const

inline

Returns the shortcut item ID specified by the index.

Parameters

index

Index of the shortcut item.

Definition at line 71 of file shortcutbase.h.

        { return mItems[index]; }

References mItems.

Referenced by VirtShortcutContainer::draw(), DropShortcut::dropFirst(), DropShortcut::dropItem(), VirtShortcutContainer::mouseDragged(), VirtShortcutContainer::mouseMoved(), VirtShortcutContainer::mousePressed(), and VirtShortcutContainer::safeDraw().

getItemColor()

ItemColor ShortcutBase::getItemColor ( const size_t  index ) const

inline

Definition at line 74 of file shortcutbase.h.

        { return mItemColors[index]; }

References mItemColors.

Referenced by VirtShortcutContainer::draw(), DropShortcut::dropFirst(), DropShortcut::dropItem(), VirtShortcutContainer::mouseDragged(), VirtShortcutContainer::mouseMoved(), VirtShortcutContainer::mousePressed(), and VirtShortcutContainer::safeDraw().

getItemCount()

int ShortcutBase::getItemCount ( ) const

inline

Returns the amount of shortcut items.

Definition at line 80 of file shortcutbase.h.

        { return CAST_S32(mMaxSize); }

References CAST_S32, and mMaxSize.

Referenced by VirtShortcutContainer::VirtShortcutContainer().

getItemSelected()

int ShortcutBase::getItemSelected ( ) const

inline

Returns the item ID that is currently selected.

Definition at line 86 of file shortcutbase.h.

        { return mItemSelected; }

References mItemSelected.

isItemSelected()

bool ShortcutBase::isItemSelected ( ) const

inline

A flag to check if the item is selected.

Definition at line 120 of file shortcutbase.h.

        { return mItemSelected > -1; }

References mItemSelected.

Referenced by VirtShortcutContainer::mouseReleased().

load()

void ShortcutBase::load

(

)

Load the configuration information.

Definition at line 54 of file shortcutbase.cpp.

{
    const Configuration *cfg = &serverConfig;
 
    for (size_t i = 0; i < mMaxSize; i++)
    {
        const std::string num = toString(CAST_S32(i));
        const int itemId = cfg->getValue(mItemName + num, -1);
        const ItemColor itemColor = fromInt(
            cfg->getValue(mColorName + num, -1),
            ItemColor);
 
        if (itemId != -1)
        {
            mItems[i] = itemId;
            mItemColors[i] = itemColor;
        }
    }
}

References CAST_S32, fromInt, ConfigurationObject::getValue(), mColorName, mItemColors, mItemName, mItems, mMaxSize, serverConfig, and Catch::toString().

Referenced by DropShortcut::DropShortcut(), and ShortcutBase().

removeItem()

void ShortcutBase::removeItem ( const size_t  index )

inline

Remove a item from the shortcut.

Definition at line 126 of file shortcutbase.h.

        { mItems[index] = -1; save(); }

References mItems, and save().

Referenced by VirtShortcutContainer::mouseDragged().

save()

void ShortcutBase::save

(

)

const

Save the configuration information.

Definition at line 74 of file shortcutbase.cpp.

{
    for (size_t i = 0; i < mMaxSize; i++)
    {
        const int itemId = mItems[i] != 0 ? mItems[i] : -1;
        const std::string num = toString(CAST_S32(i));
        if (itemId != -1)
        {
            const int itemColor = (mItemColors[i] != ItemColor_zero)
                ? toInt(mItemColors[i], int) : 1;
            serverConfig.setValue(mItemName + num, itemId);
            serverConfig.setValue(mColorName + num, itemColor);
        }
        else
        {
            serverConfig.deleteKey(mItemName + num);
            serverConfig.deleteKey(mColorName + num);
        }
    }
}

References CAST_S32, ConfigurationObject::deleteKey(), ItemColor_zero, mColorName, mItemColors, mItemName, mItems, mMaxSize, serverConfig, Configuration::setValue(), toInt, and Catch::toString().

Referenced by clear(), removeItem(), setItem(), and setItems().

setItem()

void ShortcutBase::setItem

(

const size_t

index

)

Adds the selected item ID to the items specified by the index.

Parameters

index

Index of the items.

Definition at line 109 of file shortcutbase.cpp.

{
    if (index >= mMaxSize)
        return;
 
    mItems[index] = mItemSelected;
    mItemColors[index] = mItemColorSelected;
    save();
}

References mItemColors, mItemColorSelected, mItems, mItemSelected, mMaxSize, and save().

setItems()

void ShortcutBase::setItems ( const size_t  index, const int  itemId, const ItemColor  color  )

inline

Adds an item to the items store specified by the index.

Parameters

index	Index of the item.
itemId	ID of the item.

Definition at line 102 of file shortcutbase.h.

        { mItems[index] = itemId; mItemColors[index] = color; save(); }

References mItemColors, mItems, and save().

Referenced by VirtShortcutContainer::mousePressed(), and VirtShortcutContainer::mouseReleased().

setItemSelected() [1/2]

void ShortcutBase::setItemSelected ( const int  itemId )

inline

Set the item that is selected.

Parameters

itemId

The ID of the item that is to be assigned.

Definition at line 112 of file shortcutbase.h.

        { mItemSelected = itemId; }

References mItemSelected.

Referenced by VirtShortcutContainer::mouseReleased().

setItemSelected() [2/2]

void ShortcutBase::setItemSelected

(

const Item *const

item

)

Definition at line 95 of file shortcutbase.cpp.

{
    if (item != nullptr)
    {
        mItemSelected = item->getId();
        mItemColorSelected = item->getColor();
    }
    else
    {
        mItemSelected = -1;
        mItemColorSelected = ItemColor_one;
    }
}

References Item::getColor(), Item::getId(), ItemColor_one, mItemColorSelected, and mItemSelected.

Field Documentation

mColorName

std::string ShortcutBase::mColorName

private

Definition at line 135 of file shortcutbase.h.

Referenced by load(), and save().

mItemColors

ItemColor* ShortcutBase::mItemColors

private

Definition at line 133 of file shortcutbase.h.

Referenced by clear(), getItemColor(), load(), save(), setItem(), setItems(), and ~ShortcutBase().

mItemColorSelected

ItemColor ShortcutBase::mItemColorSelected

private

Definition at line 138 of file shortcutbase.h.

Referenced by setItem(), and setItemSelected().

mItemName

std::string ShortcutBase::mItemName

private

Definition at line 134 of file shortcutbase.h.

Referenced by load(), and save().

mItems

int* ShortcutBase::mItems

private

Definition at line 132 of file shortcutbase.h.

Referenced by clear(), getItem(), load(), removeItem(), save(), setItem(), setItems(), and ~ShortcutBase().

mItemSelected

int ShortcutBase::mItemSelected

private

Definition at line 137 of file shortcutbase.h.

Referenced by getItemSelected(), isItemSelected(), setItem(), and setItemSelected().

mMaxSize

size_t ShortcutBase::mMaxSize

private

Definition at line 136 of file shortcutbase.h.

Referenced by clear(), getItemCount(), load(), save(), and setItem().

---

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

• src/gui/shortcut/shortcutbase.h (986a3bf)
• src/gui/shortcut/shortcutbase.cpp (986a3bf)