IListBoxDrawItemEvent

The IListBoxDrawItemEvent class provides event information for drawing items in a list box.


IListBoxDrawItemEvent - Member Functions and Data by Group

Constructors & Destructor

You can construct and destruct objects of this class.

Although you can construct objects of this class, typically IListBoxDrawItemHandler::dispatchHandlerEvent creates objects of this class from an object of the class IEvent.


[view class]
~IListBoxDrawItemEvent
public:
virtual ~IListBoxDrawItemEvent()

Supported Platforms

Windows OS/2 AIX
Yes Yes No


[view class]
IListBoxDrawItemEvent
public:
IListBoxDrawItemEvent(IEvent& event)

Constructs an object of this class. The only way to construct an object of this class is from an object of the class IEvent.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


Event Information

Use these members to query information about the list box item.


[view class]
isSelected
public:
bool isSelected() const

If the list box item is selected, true is returned. Otherwise, false is returned.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


Selection State

Use these members to manage the drawing of selection state emphasis.


[view class]
isSelectionStateDrawn
public:
bool isSelectionStateDrawn() const

Returns a flag indicating if the handler has drawn the list box item to indicate its selection status. This function returns the value set with setSelectionStateDrawn. If the latter function has not been called, false is returned.

This value is ignored if drawItem, selectItem, or deselectItem of the IListBoxDrawItemHandler that is processing the event returns false. If the handler returns true and isSelectionStateDrawn returns true, the windowing system stops drawing the item. If the handler returns true and isSelectionStateDrawn returns false, the windowing system changes the highlighting of the item.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


[view class]
setSelectionStateDrawn
public:
IListBoxDrawItemEvent& setSelectionStateDrawn( bool drawn = true )

Sets whether the handler has drawn the list box item to indicate its selection status. If the function has not been called, the handler has not drawn the item's selection status.

The value set by this function is ignored if drawItem, selectItem, or deselectItem of the IListBoxDrawItemHandler that is processing the event returns false. If the handler returns true and setSelectionStateDrawn is called with true, the windowing system stops drawing the item. If the handler returns true and setSelectionStateDrawn is called with false, the windowing system changes the highlighting of the item.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


IListBoxDrawItemEvent - Inherited Member Functions and Data

Inherited Public Functions

IControlEvent
IDrawItemEvent
IEvent

Inherited Public Data

Inherited Protected Functions

IDrawItemEvent

Inherited Protected Data