Public Member Functions | Public Attributes

FBContainer Class Reference

This reference page is linked to from the following overview topics: Events & callbacks.


Search for all occurrences

Detailed Description

Used to create a container for a tool UI.

Definition at line 1649 of file fbcontrols.h.

#include <fbcontrols.h>

Inheritance diagram for FBContainer:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  FBContainer ()
  Constructor.
virtual bool  ItemIconSet (kReference pRef, HFBImageContainer pImage, bool pUseACopyOfTheImage=true)
  Set an item's icon.
virtual bool  ItemIconSet (kReference pRef, char *pFilename)
  Set an item's icon.
virtual bool  ItemNameEdit (kReference pRef)
  Edit a container item.
virtual int  GetSelection ()
  Get the selected item.

Public Attributes

FBPropertyStringList  Items
  List: Names of items in container.
FBPropertyInt  ItemIndex
  Read Write Property: Current item selected.
FBPropertyOrientation  Orientation
  Read Write Property: Orientation of container.
FBPropertyBool  ItemWrap
  Read Write Property: Are items wrapped when enough space is available?
FBPropertyIconPosition  IconPosition
  Read Write Property: Where the icon is positioned for the items.
FBPropertyInt  ItemWidth
  Read Write Property: Item width.
FBPropertyInt  ItemHeight
  Read Write Property: Item height.
FBPropertyEvent  OnChange
  Event: Container contents changed.
FBPropertyEvent  OnDblClick
  Event: Double click.
FBPropertyEvent  OnDragAndDrop
  Event: Drag and Drop event.

Constructor & Destructor Documentation

Constructor.


Member Function Documentation

virtual bool ItemIconSet ( kReference  pRef,
HFBImageContainer  pImage,
bool  pUseACopyOfTheImage = true 
) [virtual]

Set an item's icon.

Parameters:
pRef Reference to item in container.
pImage Handle to image to use.
pUseACopyOfTheImage Create a copy of the image?(default=true)
Returns:
Operation was successful (true or false).
virtual bool ItemIconSet ( kReference  pRef,
char *  pFilename 
) [virtual]

Set an item's icon.

Parameters:
pRef Reference to item in container.
pFilename Name of file where image is located.
Returns:
Operation was successful (true or false).
virtual bool ItemNameEdit ( kReference  pRef ) [virtual]

Edit a container item.

Parameters:
pRef Reference of container to edit.
Returns:
Operation was successful (true or false).
virtual int GetSelection ( ) [virtual]

Get the selected item.

Returns:
Index of current selection.

Member Data Documentation

List: Names of items in container.

Definition at line 1682 of file fbcontrols.h.

Read Write Property: Current item selected.

Definition at line 1684 of file fbcontrols.h.

FBPropertyOrientation Orientation

Read Write Property: Orientation of container.

Definition at line 1685 of file fbcontrols.h.

Read Write Property: Are items wrapped when enough space is available?

Definition at line 1686 of file fbcontrols.h.

FBPropertyIconPosition IconPosition

Read Write Property: Where the icon is positioned for the items.

Definition at line 1687 of file fbcontrols.h.

Read Write Property: Item width.

Definition at line 1688 of file fbcontrols.h.

Read Write Property: Item height.

Definition at line 1689 of file fbcontrols.h.

Event: Container contents changed.

Definition at line 1691 of file fbcontrols.h.

Event: Double click.

Definition at line 1692 of file fbcontrols.h.

Event: Drag and Drop event.

Definition at line 1693 of file fbcontrols.h.


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

FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer
FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer