rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

Classes | Macros | Typedefs
itemgdt.h File Reference
#include <ilviews/base/iostream.h>
#include <ilviews/base/graphic.h>
#include <ilviews/gadgets/itemtool.h>
#include <ilviews/base/value.h>
#include <ilviews/base/alloc.h>
#include <ilviews/util/animator.h>
#include <ilviews/bidi/interf.h>

Classes

class  IlvGadgetItem
 Gadget Item class. More...
 
class  IlvGadgetItemHolder
 Item holder class. More...
 
class  IlvListGadgetItemHolder
 Item holder class. More...
 

Macros

#define DeclareGadgetItemInfo()
 
#define DeclareGadgetItemInfoRO()
 
#define DeclareGadgetItemIOConstructors(classname)
 
#define IlvPredefinedGadgetItemIOMembers(classname)
 
#define IlvRegisterGadgetItemClass(classname, superclass)
 

Typedefs

typedef IlBoolean(* IlvApplyGadgetItem )(IlvGadgetItem *item, IlAny arg)
 
typedef int(* IlvListCompareFunction )(const char *string1, const char *string2, IlAny data1, IlAny data2)
 

Detailed Description

[library ilvgadgt ilviews/gadgets/itemgdt.h] Declaration of the IlvGadgetItem and related classes

Macro Definition Documentation

#define DeclareGadgetItemInfo ( )

Use this macro to declare the input/output routines of your gadget item subclass readItem, write, and copy.

See Also
DeclareGadgetItemInfoRO, DeclareGadgetItemIOConstructors
#define DeclareGadgetItemInfoRO ( )

Use this macro to declare the input/output routines of your gadget item subclass when you do not need to add the write member function (that is, your gadget item subtype do not add any new data that needs to be saved, and the implementation of the write member function in the parent class already does the job).

See Also
DeclareGadgetItemInfo, DeclareGadgetItemIOConstructors.
#define DeclareGadgetItemIOConstructors (   classname)

Use this macro to declare the input/output constructors of your gadget item subclass.

Parameters
classnameThe class name.
See Also
DeclareGadgetItemInfoRO, DeclareGadgetItemInfo
#define IlvPredefinedGadgetItemIOMembers (   classname)

Use this macro to provide a default implementation for the copy and readItem member functions of the IlvGadgetItem class when subclassing it.

Parameters
classnameThe name of the class.
See Also
DeclareGadgetItemIOConstructors, DeclareGadgetItemInfo.
#define IlvRegisterGadgetItemClass (   classname,
  superclass 
)

Use this macro to register your subclass of IlvGadgetItem.

Parameters
classnameThe name of the class being registered.
superclassThe superclass of classname.

Typedef Documentation

IlvApplyGadgetItem

Defines the type of the function used by the IlvGadgetItemHolder::applyToItems method.

Parameters
itemThe item on which the function is invoked.
argThe argument passed to the function.
Returns
The function should return IlFalse to stop the apply mechanism, or IlTrue to continue.
See Also
IlvGadgetItemHolder::applyToItems.
IlvListCompareFunction

Defines the type of the function used by the sorting algorithm of the IlvListGadgetItemHolder to compare two items.

Parameters
string1The label of the first item.
string2The label of the second item.
value1The client data of the first item.
value2The client data of the second item.
See Also
IlvListGadgetItemHolder::sort

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.