ItemShortcutContainer Class Reference

An item shortcut container. More...

#include <itemshortcutcontainer.h>

Inheritance diagram for ItemShortcutContainer:

Public Member Functions
	ItemShortcutContainer ()
	~ItemShortcutContainer () override
void	draw (gcn::Graphics *graphics) override
	Draws the items.
void	mouseDragged (gcn::MouseEvent &event) override
	Handles mouse when dragged.
void	mousePressed (gcn::MouseEvent &event) override
	Handles mouse when pressed.
void	mouseReleased (gcn::MouseEvent &event) override
	Handles mouse release.
Public Member Functions inherited from ShortcutContainer
	ShortcutContainer ()
void	drawFrame (gcn::Graphics *graphics) override
void	widgetResized (const gcn::Event &event) override
	Invoked when a widget changes its size.
int	getMaxItems () const
int	getBoxWidth () const
int	getBoxHeight () const

Private Member Functions
void	mouseExited (gcn::MouseEvent &event) override
void	mouseMoved (gcn::MouseEvent &event) override
Item *	getItemAt (int x, int y) const

Private Attributes
bool	mItemClicked = false
Item *	mItemMoved = nullptr
std::unique_ptr< ItemPopup >	mItemPopup

Additional Inherited Members
Protected Member Functions inherited from ShortcutContainer
int	getIndexFromGrid (int pointX, int pointY) const
	Gets the index from the grid provided the point is in an item box.
Protected Attributes inherited from ShortcutContainer
int	mMaxItems = 0
int	mBoxWidth = 0
int	mBoxHeight = 0
int	mCursorPosX = 0
int	mCursorPosY = 0
int	mGridWidth = 1
int	mGridHeight = 1

Detailed Description

An item shortcut container.

Used to quickly use items.

Definition at line 39 of file itemshortcutcontainer.h.

Constructor & Destructor Documentation

ItemShortcutContainer()

ItemShortcutContainer::ItemShortcutContainer

(

)

Definition at line 40 of file itemshortcutcontainer.cpp.

~ItemShortcutContainer()

ItemShortcutContainer::~ItemShortcutContainer ( )

overridedefault

Member Function Documentation

draw()

void ItemShortcutContainer::draw ( gcn::Graphics *  graphics )

overridevirtual

Draws the items.

Implements ShortcutContainer.

Definition at line 48 of file itemshortcutcontainer.cpp.

getItemAt()

Item * ItemShortcutContainer::getItemAt ( int  x, int  y  ) const

private

Definition at line 218 of file itemshortcutcontainer.cpp.

mouseDragged()

void ItemShortcutContainer::mouseDragged ( gcn::MouseEvent &  event )

override

Handles mouse when dragged.

Definition at line 115 of file itemshortcutcontainer.cpp.

mouseExited()

void ItemShortcutContainer::mouseExited ( gcn::MouseEvent &  event )

overrideprivate

Definition at line 232 of file itemshortcutcontainer.cpp.

mouseMoved()

void ItemShortcutContainer::mouseMoved ( gcn::MouseEvent &  event )

overrideprivate

Definition at line 205 of file itemshortcutcontainer.cpp.

mousePressed()

void ItemShortcutContainer::mousePressed ( gcn::MouseEvent &  event )

override

Handles mouse when pressed.

Definition at line 144 of file itemshortcutcontainer.cpp.

mouseReleased()

void ItemShortcutContainer::mouseReleased ( gcn::MouseEvent &  event )

override

Handles mouse release.

Definition at line 176 of file itemshortcutcontainer.cpp.

Member Data Documentation

mItemClicked

bool ItemShortcutContainer::mItemClicked = false

private

Definition at line 72 of file itemshortcutcontainer.h.

mItemMoved

Item* ItemShortcutContainer::mItemMoved = nullptr

private

Definition at line 73 of file itemshortcutcontainer.h.

mItemPopup

std::unique_ptr<ItemPopup> ItemShortcutContainer::mItemPopup

private

Definition at line 75 of file itemshortcutcontainer.h.

---

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

• src/gui/widgets/itemshortcutcontainer.h
• src/gui/widgets/itemshortcutcontainer.cpp