DropDownListItem Class Reference

Base list item class from which others are derived. More...

#include <dropdown_type.h>

Inheritance diagram for DropDownListItem:

Public Member Functions
	DropDownListItem (int result, bool masked=false, bool shaded=false)
virtual	~DropDownListItem ()=default
	Ensure the destructor of the sub classes are called as well.
virtual void	FilterText (StringFilter &string_filter) const
	Add text from this dropdown item to a string filter.
virtual bool	Selectable () const
	Can this dropdown item be selected?
virtual uint	Height () const
	The height of this item.
virtual uint	Width () const
	The width of this item.
virtual int	OnClick (const Rect &r, const Point &pt) const
	Callback when this item is clicked.
virtual void	Draw (const Rect &full, const Rect &r, bool sel, int click_result, Colours bg_colour) const
	Callback for drawing this item.
TextColour	GetColour (bool sel) const
	Get the colour of the text.

Data Fields
int	result
	Result value to return to window on selection.
bool	masked
	Masked and unselectable item.
bool	shaded
	Shaded item, affects text colour.

Detailed Description

Base list item class from which others are derived.

Definition at line 24 of file dropdown_type.h.

Constructor & Destructor Documentation

DropDownListItem()

DropDownListItem::DropDownListItem ( int result, bool masked = false, bool shaded = false )

inlineexplicit

Definition at line 30 of file dropdown_type.h.

Member Function Documentation

Draw()

virtual void DropDownListItem::Draw ( const Rect & full, const Rect & r, bool sel, int click_result, Colours bg_colour ) const

inlinevirtual

Callback for drawing this item.

Parameters

full	The full bounds of the item including padding.
r	The bounds to draw the item in.
sel	Whether the item is elected or not.
click_result	When selected, the previously set 'click_result' otherwise -1.
bg_colour	The background color for the item.

Definition at line 77 of file dropdown_type.h.

References FILLRECT_CHECKER, GetColourGradient(), GfxFillRect(), and Rect.

FilterText()

virtual void DropDownListItem::FilterText ( StringFilter & string_filter ) const

inlinevirtual

Add text from this dropdown item to a string filter.

Parameters

string_filter

String filter to add text to.

Reimplemented in DropDownString< DropDownListItem >.

Definition at line 38 of file dropdown_type.h.

Referenced by DropdownWindow::FilterByText().

GetColour()

TextColour DropDownListItem::GetColour ( bool sel ) const

inline

Get the colour of the text.

Parameters

sel	Whether the item is selected or not.

Returns

The text colour.

Definition at line 87 of file dropdown_type.h.

References TC_NO_SHADE.

Height()

virtual uint DropDownListItem::Height ( ) const

inlinevirtual

The height of this item.

Returns

The height.

Definition at line 50 of file dropdown_type.h.

OnClick()

virtual int DropDownListItem::OnClick ( const Rect & r, const Point & pt ) const

inlinevirtual

Callback when this item is clicked.

Parameters

r	The bounds of this item.
pt	The location within the bounds where the item is clicked.

Returns

The 'click_result' for the OnDropdownClose callback on the dropdown's parent.

Definition at line 64 of file dropdown_type.h.

References Point, and Rect.

Selectable()

virtual bool DropDownListItem::Selectable ( ) const

inlinevirtual

Can this dropdown item be selected?

Returns

Whether this item can be selected.

Definition at line 44 of file dropdown_type.h.

Width()

virtual uint DropDownListItem::Width ( ) const

inlinevirtual

The width of this item.

Returns

The width.

Definition at line 56 of file dropdown_type.h.

Field Documentation

masked

bool DropDownListItem::masked

Masked and unselectable item.

Definition at line 27 of file dropdown_type.h.

result

int DropDownListItem::result

Result value to return to window on selection.

Definition at line 26 of file dropdown_type.h.

shaded

bool DropDownListItem::shaded

Shaded item, affects text colour.

Definition at line 28 of file dropdown_type.h.

---

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

• src/dropdown_type.h