INDICATOR_ICON Class Reference

Represent a row indicator icon for use in places like the layer widget. More...

#include <indicator_icon.h>

Inheritance diagram for INDICATOR_ICON:

Classes
class	ICON_PROVIDER
	A simple object that can provide fixed bitmaps for use as row indicators. More...

Public Types
using	ICON_ID = int
	An id that refers to a certain icon state.

Public Member Functions
	INDICATOR_ICON (wxWindow *aParent, ICON_PROVIDER &aIconProvider, ICON_ID aInitialIcon, int aID)
void	SetIndicatorState (ICON_ID aIconId)
	Set the row indicator to the given state.
void	SetWindowID (wxWindowID aId)
	Update the window ID of this control and its children.

Private Attributes
ICON_PROVIDER &	m_iconProvider
wxStaticBitmap *	m_bitmap
	Object that delivers icons for the indicator.
ICON_ID	m_currentId
	Handle on the bitmap widget.

Detailed Description

Represent a row indicator icon for use in places like the layer widget.

Definition at line 34 of file indicator_icon.h.

Member Typedef Documentation

ICON_ID

using INDICATOR_ICON::ICON_ID = int

An id that refers to a certain icon state.

Exactly what that state might mean in terms of icons is up to the icon provider.

Definition at line 42 of file indicator_icon.h.

Constructor & Destructor Documentation

INDICATOR_ICON()

INDICATOR_ICON::INDICATOR_ICON	(	wxWindow *	aParent,
		ICON_PROVIDER &	aIconProvider,
		ICON_ID	aInitialIcon,
		int	aID )

Parameters

aParent	the owning window.
aIconProvider	the icon provider to get icons from.
aInitialIcon	is the initial state of the icon.
aID	the ID to use for the widgets - events will have this ID.

Definition at line 31 of file indicator_icon.cpp.

References m_bitmap, m_currentId, and m_iconProvider.

Member Function Documentation

SetIndicatorState()

void INDICATOR_ICON::SetIndicatorState

(

ICON_ID

aIconId

)

Set the row indicator to the given state.

Parameters

aIconId

the icon ID to pass to the provider.

Definition at line 55 of file indicator_icon.cpp.

References m_bitmap, m_currentId, and m_iconProvider.

Referenced by APPEARANCE_CONTROLS::OnLayerChanged(), LAYER_WIDGET::SelectLayerRow(), LAYER_WIDGET::UpdateLayerIcons(), and LAYER_WIDGET::updateLayerRow().

SetWindowID()

void INDICATOR_ICON::SetWindowID ( wxWindowID aId )

inline

Update the window ID of this control and its children.

Parameters

aId	new Window ID to set.

Definition at line 80 of file indicator_icon.h.

References m_bitmap.

Member Data Documentation

m_bitmap

wxStaticBitmap* INDICATOR_ICON::m_bitmap

private

Object that delivers icons for the indicator.

Definition at line 88 of file indicator_icon.h.

Referenced by INDICATOR_ICON(), SetIndicatorState(), and SetWindowID().

m_currentId

ICON_ID INDICATOR_ICON::m_currentId

private

Handle on the bitmap widget.

Definition at line 89 of file indicator_icon.h.

Referenced by INDICATOR_ICON(), and SetIndicatorState().

m_iconProvider

ICON_PROVIDER& INDICATOR_ICON::m_iconProvider

private

Definition at line 87 of file indicator_icon.h.

Referenced by INDICATOR_ICON(), and SetIndicatorState().

---

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

• indicator_icon.h
• indicator_icon.cpp