### 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.

~IListBoxDrawItemEvent

      public:
      virtual ~IListBoxDrawItemEvent()

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | No

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.

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.

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

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

  -     virtual ~IControlEvent()

  -     virtual unsigned long controlId() const

  -     IControlEvent(const IControlEvent& event)

  -     IControlEvent(const IEvent& event)

  IDrawItemEvent

  -     virtual ~IDrawItemEvent()

  -     IDrawItemEvent(const IEvent& event)

  -     virtual unsigned long itemId() const

  -     virtual IPresSpaceHandle itemPresSpaceHandle() const

  -     virtual IRectangle itemRect() const

  IEvent

  -     virtual ~IEvent()

  -     IWindowHandle controlHandle() const

  -     virtual IWindow* controlWindow() const

  -     IEvent& decrementOwnerLevels()

  -     virtual IWindow* dispatchingWindow() const

  -     unsigned long eventId() const

  -     IWindowHandle handle() const

  -     IEvent( const IWindowHandle& handle,
                unsigned long eventId,
                const IEventParameter1& parameter1,
                const IEventParameter2& parameter2 )

  -     IEvent( IWindow* window,
                unsigned long eventId,
                const IEventParameter1& parameter1,
                const IEventParameter2& parameter2 )

  -     IEvent(const IEvent& event)

  -     IEvent& operator =(const IEvent& event)

  -     IEventParameter1 parameter1() const

  -     IEventParameter2 parameter2() const

  -     bool passToOwner() const

  -     IEventResult result() const

  -     IEvent& setControlHandle(const IWindowHandle& handle)

  -     IEvent& setDispatchingHandle(const IWindowHandle& handle)

  -     IEvent& setDispatchingWindow(IWindow* window)

  -     IEvent& setHandle(const IWindowHandle& handle)

  -     IEvent& setNumberOfLevels(int levels = - 1)

  -     IEvent& setPassToOwner(bool passOn = true)

  -     IEvent& setResult(bool eventResult)

  -     IEvent& setResult(const IEventResult& eventResult)

  -     virtual IWindow* window() const

#### Inherited Public Data

  - None

#### Inherited Protected Functions

  IDrawItemEvent

  -     void* ownerItemData() const

#### Inherited Protected Data

  - None