FX::FXIconItem Class Reference

#include <FXIconList.h>

Inheritance diagram for FX::FXIconItem:

Inheritance graph
[legend]

List of all members.


Detailed Description

Icon item.

Public Types

enum  {
  SELECTED, FOCUS, DISABLED, DRAGGABLE,
  BIGICONOWNED, MINIICONOWNED
}

Public Member Functions

 FXIconItem (const FXString &text, FXIcon *bi=NULL, FXIcon *mi=NULL, void *ptr=NULL)
virtual void setText (const FXString &txt)
const FXStringgetText () const
virtual void setBigIcon (FXIcon *icn, FXbool owned=FALSE)
FXIcongetBigIcon () const
virtual void setMiniIcon (FXIcon *icn, FXbool owned=FALSE)
FXIcongetMiniIcon () const
void setData (void *ptr)
void * getData () const
virtual void setFocus (FXbool focus)
FXbool hasFocus () const
virtual void setSelected (FXbool selected)
FXbool isSelected () const
virtual void setEnabled (FXbool enabled)
FXbool isEnabled () const
virtual void setDraggable (FXbool draggable)
FXbool isDraggable () const
virtual FXint getWidth (const FXIconList *list) const
virtual FXint getHeight (const FXIconList *list) const
virtual void create ()
virtual void detach ()
virtual void destroy ()
virtual void save (FXStream &store) const
virtual void load (FXStream &store)
virtual ~FXIconItem ()
virtual long onDefault (FXObject *, FXSelector, void *)
const FXchar * getClassName () const
bool isMemberOf (const FXMetaClass *metaclass) const
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
QTransString tr (const char *text, const char *hint=0)
virtual void * getPythonObject () const
virtual void decouplePythonObject () const

Protected Member Functions

virtual void draw (const FXIconList *list, FXDC &dc, FXint x, FXint y, FXint w, FXint h) const
virtual FXint hitItem (const FXIconList *list, FXint rx, FXint ry, FXint rw=1, FXint rh=1) const
virtual void drawBigIcon (const FXIconList *list, FXDC &dc, FXint x, FXint y, FXint w, FXint h) const
virtual void drawMiniIcon (const FXIconList *list, FXDC &dc, FXint x, FXint y, FXint w, FXint h) const
virtual void drawDetails (const FXIconList *list, FXDC &dc, FXint x, FXint y, FXint w, FXint h) const

Protected Attributes

FXString label
FXIconbigIcon
FXIconminiIcon
void * data
FXuint state

Friends

class FXIconList
class FXFileList

Member Enumeration Documentation

anonymous enum

Enumerator:
FOCUS  Selected.
DISABLED  Focus.
DRAGGABLE  Disabled.
BIGICONOWNED  Draggable.
MINIICONOWNED  Big icon owned by item.


Constructor & Destructor Documentation

FX::FXIconItem::FXIconItem ( const FXString text,
FXIcon bi = NULL,
FXIcon mi = NULL,
void *  ptr = NULL 
) [inline]

Construct new item with given text, icons, and user-data.

virtual FX::FXIconItem::~FXIconItem (  )  [virtual]

Destroy item and free icons if owned.


Member Function Documentation

virtual void FX::FXIconItem::setText ( const FXString txt  )  [virtual]

Change item's text label.

const FXString& FX::FXIconItem::getText (  )  const [inline]

Return item's text label.

virtual void FX::FXIconItem::setBigIcon ( FXIcon icn,
FXbool  owned = FALSE 
) [virtual]

Change item's big icon, deleting the old icon if it was owned.

FXIcon* FX::FXIconItem::getBigIcon (  )  const [inline]

Return item's big icon.

virtual void FX::FXIconItem::setMiniIcon ( FXIcon icn,
FXbool  owned = FALSE 
) [virtual]

Change item's mini icon, deleting the old icon if it was owned.

FXIcon* FX::FXIconItem::getMiniIcon (  )  const [inline]

Return item's mini icon.

void FX::FXIconItem::setData ( void *  ptr  )  [inline]

Change item's user data.

void* FX::FXIconItem::getData (  )  const [inline]

Get item's user data.

virtual void FX::FXIconItem::setFocus ( FXbool  focus  )  [virtual]

Make item draw as focused.

FXbool FX::FXIconItem::hasFocus (  )  const [inline]

Return true if item has focus.

virtual void FX::FXIconItem::setSelected ( FXbool  selected  )  [virtual]

Select item.

FXbool FX::FXIconItem::isSelected (  )  const [inline]

Return true if this item is selected.

virtual void FX::FXIconItem::setEnabled ( FXbool  enabled  )  [virtual]

Enable or disable item.

FXbool FX::FXIconItem::isEnabled (  )  const [inline]

Return true if this item is enabled.

virtual void FX::FXIconItem::setDraggable ( FXbool  draggable  )  [virtual]

Make item draggable.

FXbool FX::FXIconItem::isDraggable (  )  const [inline]

Return true if this item is draggable.

virtual FXint FX::FXIconItem::getWidth ( const FXIconList list  )  const [virtual]

Return width of item as drawn in list.

virtual FXint FX::FXIconItem::getHeight ( const FXIconList list  )  const [virtual]

Return height of item as drawn in list.

virtual void FX::FXIconItem::create (  )  [virtual]

Create server-side resources.

virtual void FX::FXIconItem::detach (  )  [virtual]

Detach server-side resources.

virtual void FX::FXIconItem::destroy (  )  [virtual]

Destroy server-side resources.

virtual void FX::FXIconItem::save ( FXStream store  )  const [virtual]

Save to stream.

Reimplemented from FX::FXObject.

virtual void FX::FXIconItem::load ( FXStream store  )  [virtual]

Load from stream.

Reimplemented from FX::FXObject.

virtual long FX::FXObject::onDefault ( FXObject ,
FXSelector  ,
void *   
) [virtual, inherited]

Called for unhandled messages.

Reimplemented in FX::FXDelegator, FX::FXGLViewer, FX::FXMDIChild, and FX::FXMDIClient.

const FXchar* FX::FXObject::getClassName (  )  const [inherited]

Get class name of some object.

bool FX::FXObject::isMemberOf ( const FXMetaClass metaclass  )  const [inherited]

Check if object is member of metaclass.

virtual long FX::FXObject::tryHandle ( FXObject sender,
FXSelector  sel,
void *  ptr 
) [virtual, inherited]

Try handle message safely.

QTransString FX::FXObject::tr ( const char *  text,
const char *  hint = 0 
) [inherited]

Returns a human translated version of the text to the locale language (warning: uses a virtual method call, so can't use before construction)

virtual void* FX::FXObject::getPythonObject (  )  const [inline, virtual, inherited]

Returns the python object representing this instance (if created in python).

virtual void FX::FXObject::decouplePythonObject (  )  const [inline, virtual, inherited]

Causes decoupling of python object from this object (deletes self).


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

(C) 2002-2008 Niall Douglas. Some parts (C) to assorted authors.
Generated on Fri Jun 13 22:01:33 2008 for TnFOX by doxygen v1.5.6