ItemPopup Class Reference

A popup that displays information about an item. More...

#include <itempopup.h>

Inheritance diagram for ItemPopup:

Public Member Functions
	ItemPopup ()
	Constructor.
	~ItemPopup () override
	Destructor.
void	setNoItem ()
	Tells the item popup to say: No Item.
void	setEquipmentText (const std::string &text=std::string())
	Tells in which equipment slot the item is equipped.
void	setItem (const ItemInfo &item, bool showImage=false)
	Sets the info to be displayed given a particular item.
void	mouseMoved (gcn::MouseEvent &mouseEvent) override
Public Member Functions inherited from Popup
	Popup (const std::string &name=std::string(), SkinType skinType=SkinType::Popup)
	Constructor.
	~Popup () override
	Destructor.
void	add (gcn::Widget *widget) override
void	add (gcn::Widget *widget, int x, int y) override
void	draw (gcn::Graphics *graphics) override
	Draws the popup.
void	drawFrame (gcn::Graphics *graphics) override
	Draws the popup frame.
void	setContentSize (int width, int height)
	Sets the size of this popup.
void	setLocationRelativeTo (gcn::Widget *widget)
	Sets the location relative to the given widget.
void	mouseMoved (gcn::MouseEvent &event) override
void	setMinWidth (int width)
	Sets the minimum width of the popup.
int	getMinWidth () const
void	setMinHeight (int height)
	Sets the minimum height of the popup.
int	getMinHeight () const
void	setMaxWidth (int width)
	Sets the maximum width of the popup.
int	getMaxWidth () const
void	setMaxHeight (int height)
	Sets the minimum height of the popup.
int	getMaxHeight () const
int	getPadding () const
	Gets the padding of the popup.
void	setPadding (int padding)
void	setPopupName (const std::string &name)
	Sets the name of the popup.
const std::string &	getPopupName () const
void	scheduleDelete ()
	Schedule this popup for deletion.
gcn::Rectangle	getChildrenArea () override
void	position (int x, int y)
	Sets the location to display the popup.
const Skin &	getSkin () const
	Returns the Skin used by this popup.
Public Member Functions inherited from Container
	Container ()
	~Container () override
void	drawFrame (gcn::Graphics *graphics) override

Private Attributes
Label *	mItemName
TextBox *	mItemDesc
TextBox *	mItemEffect
TextBox *	mItemWeight
std::string	mItemEquipSlot
ItemType	mItemType
Icon *	mIcon

Additional Inherited Members
Static Public Member Functions inherited from Popup
static void	setWindowContainer (WindowContainer *windowContainer)
	Sets the window container to be used by new popups.
Protected Member Functions inherited from Container
Layout &	getLayout ()
	Gets the layout handler for this container.
LayoutCell &	place (int x, int y, gcn::Widget *wg, int w=1, int h=1)
	Adds a widget to the container and sets it at given cell.
ContainerPlacer	getPlacer (int x, int y)
	Returns a proxy for adding widgets in an inner table of the layout.

Detailed Description

A popup that displays information about an item.

Definition at line 38 of file itempopup.h.

Constructor & Destructor Documentation

ItemPopup()

ItemPopup::ItemPopup

(

)

Constructor.

Initializes the item popup.

Definition at line 81 of file itempopup.cpp.

~ItemPopup()

ItemPopup::~ItemPopup ( )

overridedefault

Destructor.

Cleans up the item popup on deletion.

Member Function Documentation

mouseMoved()

void ItemPopup::mouseMoved ( gcn::MouseEvent &  mouseEvent )

override

Definition at line 232 of file itempopup.cpp.

setEquipmentText()

void ItemPopup::setEquipmentText

(

const std::string &

text = std::string()

)

Tells in which equipment slot the item is equipped.

Definition at line 116 of file itempopup.cpp.

setItem()

void ItemPopup::setItem	(	const ItemInfo &	item,
		bool	showImage = false
	)

Sets the info to be displayed given a particular item.

Definition at line 149 of file itempopup.cpp.

setNoItem()

void ItemPopup::setNoItem

(

)

Tells the item popup to say: No Item.

Definition at line 121 of file itempopup.cpp.

Member Data Documentation

mIcon

Icon* ItemPopup::mIcon

private

Definition at line 75 of file itempopup.h.

mItemDesc

TextBox* ItemPopup::mItemDesc

private

Definition at line 70 of file itempopup.h.

mItemEffect

TextBox* ItemPopup::mItemEffect

private

Definition at line 71 of file itempopup.h.

mItemEquipSlot

std::string ItemPopup::mItemEquipSlot

private

Definition at line 73 of file itempopup.h.

mItemName

Label* ItemPopup::mItemName

private

Definition at line 69 of file itempopup.h.

mItemType

ItemType ItemPopup::mItemType

private

Definition at line 74 of file itempopup.h.

mItemWeight

TextBox* ItemPopup::mItemWeight

private

Definition at line 72 of file itempopup.h.

---

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

• src/gui/itempopup.h
• src/gui/itempopup.cpp