The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page

VCF::Win32ListBox Class Reference

#include <Win32ListBox.h>

Inheritance diagram for VCF::Win32ListBox:

List of all members.

Public Member Functions
	Win32ListBox (ListBoxControl *listboxControl)
virtual	~Win32ListBox ()
virtual OSHandleID	getHandleID ()
	returns a ID that identifies this control.
virtual VCF::String	getText ()
	returns a text associated with the component.
virtual void	setText (const VCF::String &text)
	sets the text for the widget
virtual void	setBounds (VCF::Rect *rect)
	sets the bounds for the component.
virtual VCF::Rect *	getBounds ()
	returns the bounds of the component in the coordinate system of the parent.
virtual void	setVisible (const bool &visible)
	shows or hides the component.
virtual bool	getVisible ()
	returns wether or not the component is currently visible.
virtual uint32	getStyleMask ()
	returns a bit-masked uint32 that contains style constants.
virtual void	setStyleMask (const uint32 &styleMask)
	sets the current style mask.
virtual VCF::Control *	getControl ()
	returns the component that this Peer is attached to.
virtual void	setControl (VCF::Control *component)
	attahces the Peer to a particular component.
virtual void	setParent (VCF::Control *parent)
virtual VCF::Control *	getParent ()
virtual bool	isFocused ()
virtual void	setFocus (const bool &focused)
virtual bool	isEnabled ()
virtual void	setEnabled (const bool &enabled)
virtual void	createParams ()
	called before the create window is called.
virtual LRESULT	handleEventMessages (UINT message, WPARAM wParam, LPARAM lParam, WNDPROC defaultWndProc=NULL)
virtual void	setFocusedItem (ListItem *item)
	on Win32 see LB_SETCARETINDEX
virtual void	clear ()
	on Win32 see LB_RESETCONTENT
virtual void	rangeSelect (const bool &isSelected, ListItem *first, ListItem *last)
	on Win32 see LB_SELITEMRANGEEX
virtual void	selectItem (ListItem *item)
	on Win32 see LB_SETCURSEL
virtual Rect *	getItemRect ()
	on Win32 see LB_GETITEMRECT
virtual void	addItem (ListItem *item)
	on Win32 see LB_ADDSTRING
virtual void	insertItem (const uint32 &index, ListItem *item)
virtual void	removeItem (ListItem *item)
virtual bool	isItemSelected (ListItem *item)
	on Win32 see LB_GETCURSEL
virtual ListItem *	isPtOverItem (Point *point)
	returns NULL if the point passed in is not over a list item
virtual ListItem *	getFocusedItem ()
	returns a the item that has the focus in a multiple selection range.
virtual void	setItemHeight (const uint32 &itemHeight)
	on Win32 see LB_SETITEMHEIGHT
virtual ListItem *	getSelectedItem ()
	on Win32 see LB_GETCURSEL
virtual uint32	getItemHeight ()
	on Win32 see LB_GETITEMHEIGHT
virtual void	setFont (Font *font)
virtual void	repaint (Rect *repaintRect=NULL)
virtual void	keepMouseEvents ()
	this keeps the mouse events being sent to this control, even is the mouse leaves the physical bounds of the control
virtual void	releaseMouseEvents ()
	releases mouse events - goes back to normal event handling
virtual void	setCursor (Cursor *cursor)

---

Constructor & Destructor Documentation

VCF::Win32ListBox::Win32ListBox (  ListBoxControl *  listboxControl  )

virtual VCF::Win32ListBox::~Win32ListBox (   )  [virtual]

---

Member Function Documentation

virtual void VCF::Win32ListBox::addItem (  ListItem *  item  )  [virtual]

on Win32 see LB_ADDSTRING

virtual void VCF::Win32ListBox::clear (   )  [virtual]

on Win32 see LB_RESETCONTENT

virtual void VCF::Win32ListBox::createParams (   )  [virtual]

called before the create window is called. Overide this to change the style and style ex parameters. Returns a pair, the pair.first is the style parameter, the pair.second is the style ex paramater. Reimplemented from VCF::Win32Object.

virtual VCF::Rect* VCF::Win32ListBox::getBounds (   )  [inline, virtual]

returns the bounds of the component in the coordinate system of the parent. Reimplemented from VCF::AbstractWin32Component.

virtual VCF::Control* VCF::Win32ListBox::getControl (   )  [inline, virtual]

returns the component that this Peer is attached to. Reimplemented from VCF::AbstractWin32Component.

virtual ListItem* VCF::Win32ListBox::getFocusedItem (   )  [virtual]

returns a the item that has the focus in a multiple selection range. On Win32 see LB_GETCARETINDEX

virtual OSHandleID VCF::Win32ListBox::getHandleID (   )  [inline, virtual]

returns a ID that identifies this control. On Win32 this corresponds to an HWND. Reimplemented from VCF::AbstractWin32Component.

virtual uint32 VCF::Win32ListBox::getItemHeight (   )  [virtual]

on Win32 see LB_GETITEMHEIGHT

virtual Rect* VCF::Win32ListBox::getItemRect (   )  [virtual]

on Win32 see LB_GETITEMRECT

virtual VCF::Control* VCF::Win32ListBox::getParent (   )  [inline, virtual]

Reimplemented from VCF::AbstractWin32Component.

virtual ListItem* VCF::Win32ListBox::getSelectedItem (   )  [virtual]

on Win32 see LB_GETCURSEL

virtual uint32 VCF::Win32ListBox::getStyleMask (   )  [inline, virtual]

returns a bit-masked uint32 that contains style constants. These style constants are defined in the VCF, and must be translated to the particular windowing system being used.

virtual VCF::String VCF::Win32ListBox::getText (   )  [inline, virtual]

returns a text associated with the component. This usually gets used in the Component::getCaption() method. Reimplemented from VCF::AbstractWin32Component.

virtual bool VCF::Win32ListBox::getVisible (   )  [inline, virtual]

returns wether or not the component is currently visible. Reimplemented from VCF::AbstractWin32Component.

virtual LRESULT VCF::Win32ListBox::handleEventMessages (  UINT  message, WPARAM  wParam, LPARAM  lParam, WNDPROC  defaultWndProc = NULL )  [virtual]

virtual void VCF::Win32ListBox::insertItem (  const uint32 &  index, ListItem *  item )  [virtual]

virtual bool VCF::Win32ListBox::isEnabled (   )  [inline, virtual]

Reimplemented from VCF::AbstractWin32Component.

virtual bool VCF::Win32ListBox::isFocused (   )  [inline, virtual]

Reimplemented from VCF::AbstractWin32Component.

virtual bool VCF::Win32ListBox::isItemSelected (  ListItem *  item  )  [virtual]

on Win32 see LB_GETCURSEL

virtual ListItem* VCF::Win32ListBox::isPtOverItem (  Point *  point  )  [virtual]

returns NULL if the point passed in is not over a list item

virtual void VCF::Win32ListBox::keepMouseEvents (   )  [inline, virtual]

this keeps the mouse events being sent to this control, even is the mouse leaves the physical bounds of the control Reimplemented from VCF::AbstractWin32Component.

virtual void VCF::Win32ListBox::rangeSelect (  const bool &  isSelected, ListItem *  first, ListItem *  last )  [virtual]

on Win32 see LB_SELITEMRANGEEX

virtual void VCF::Win32ListBox::releaseMouseEvents (   )  [inline, virtual]

releases mouse events - goes back to normal event handling Reimplemented from VCF::AbstractWin32Component.

virtual void VCF::Win32ListBox::removeItem (  ListItem *  item  )  [virtual]

virtual void VCF::Win32ListBox::repaint (  Rect *  repaintRect = NULL  )  [inline, virtual]

virtual void VCF::Win32ListBox::selectItem (  ListItem *  item  )  [virtual]

on Win32 see LB_SETCURSEL

virtual void VCF::Win32ListBox::setBounds (  VCF::Rect *  rect  )  [inline, virtual]

sets the bounds for the component. Bounds are specified in the coordinate system of the componenents parent. Reimplemented from VCF::AbstractWin32Component.

virtual void VCF::Win32ListBox::setControl (  VCF::Control *  component  )  [inline, virtual]

attahces the Peer to a particular component. This should only be done once. Reimplemented from VCF::AbstractWin32Component.

virtual void VCF::Win32ListBox::setCursor (  Cursor *  cursor  )  [inline, virtual]

Reimplemented from VCF::AbstractWin32Component.

virtual void VCF::Win32ListBox::setEnabled (  const bool &  enabled  )  [inline, virtual]

Reimplemented from VCF::AbstractWin32Component.

virtual void VCF::Win32ListBox::setFocus (  const bool &  focused  )  [inline, virtual]

virtual void VCF::Win32ListBox::setFocusedItem (  ListItem *  item  )  [virtual]

on Win32 see LB_SETCARETINDEX

virtual void VCF::Win32ListBox::setFont (  Font *  font  )  [inline, virtual]

Reimplemented from VCF::AbstractWin32Component.

virtual void VCF::Win32ListBox::setItemHeight (  const uint32 &  itemHeight  )  [virtual]

on Win32 see LB_SETITEMHEIGHT

virtual void VCF::Win32ListBox::setParent (  VCF::Control *  parent  )  [inline, virtual]

Reimplemented from VCF::AbstractWin32Component.

virtual void VCF::Win32ListBox::setStyleMask (  const uint32 &  styleMask  )  [inline, virtual]

sets the current style mask. Should cause a repaint of the component, if neccessary.

virtual void VCF::Win32ListBox::setText (  const VCF::String &  text  )  [inline, virtual]

sets the text for the widget Reimplemented from VCF::AbstractWin32Component.

virtual void VCF::Win32ListBox::setVisible (  const bool &  visible  )  [inline, virtual]

shows or hides the component. This does NOT close the component (if invoked on a frame based component ). Reimplemented from VCF::AbstractWin32Component.

---

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

• vcf/ApplicationKit/Win32ListBox.h

Comments or Suggestions?    License Information