DzListBox Class Reference
[Interface Widget Objects]

DAZ Script list box widget. More...

Inheritance diagram for DzListBox:

DzScrollView DzWidget List of all members.

Enumerations

enum  LayoutMode { FixedNumber, FitToWidth, FitToHeight, Variable }
enum  SelectionMode { Single, Multi, Extended, NoSelection }

Properties

LayoutMode columnMode
Number count
Number currentItem
String currentText
Number numColumns
Number numItemsVisible
Number numRows
LayoutMode rowMode
Number selected
SelectionMode selectionMode
Number topItem
Boolean variableHeight
Boolean variableWidth

Methods

void clear ()
void insertItem (String text)
Boolean isSelected (Number index)
void removeItem (Number index)
void setSelected (Number index, Boolean selected)
String text (Number index)

Constructors

 DzListBox (DzWidget parent)

Signals

void clicked (Number index, Point pnt)
 Signature: "clicked(int,const QPoint&)"
void clicked (Number index)
 Signature: "clicked(int)"
void contextMenuRequested (Number index, Point pos)
 Signature: "contextMenuRequested(int,const QPoint&)"
void currentChanged (Number index)
 Signature: "currentChanged(int)"
void doubleClicked (Number index)
 Signature: "doubleClicked(int)"
void highlighted (String str)
 Signature: "highlighted(const QString&)"
void highlighted (Number index)
 Signature: "highlighted(int)"
void mouseButtonClicked (Number button, Number index, Point pos)
 Signature: "mouseButtonClicked(int,int,const QPoint&)"
void mouseButtonPressed (Number button, Number index, Point pos)
 Signature: "mouseButtonPressed(int,int,const QPoint&)"
void onItem (Number index)
 Signature: "onItem(int)"
void onViewport ()
 Signature: "onViewport()"
void pressed (Number index, Point pnt)
 Signature: "pressed(int,const QPoint&)"
void pressed (Number index)
 Signature: "pressed(int)"
void returnPressed (Number index)
 Signature: "returnPressed(int)"
void rightButtonClicked (Number index, Point pnt)
 Signature: "rightButtonClicked(int,const QPoint&)"
void rightButtonPressed (Number index, Point pnt)
 Signature: "rightButtonPressed(int,const QPoint&)"
void selected (String str)
 Signature: "selected(const QString&)"
void selected (Number index)
 Signature: "selected(int)"
void selectionChanged (Number index)
 Signature: "selectionChanged(int)"
void selectionChanged ()
 Signature: "selectionChanged()"

Detailed Description

DAZ Script list box widget.


Member Enumeration Documentation

enum DzListBox::LayoutMode

The possible layout modes for the columns and rows of the list box

Enumerator:
FixedNumber  There is a fixed number of rows or columns
FitToWidth  There are as many columns as will fit
FitToHeight  There are as many rows as will fit
Variable  There are as many rows as required by the column mode and vice-versa

enum DzListBox::SelectionMode

The possible selection modes for the list box

Enumerator:
Single  Single selection - only one item in the box can be selected at a time
Multi  Multi selection - when the user clicks on an item, its selection state is toggled, all other items remain the same
Extended  Extended selection - when the user clicks on an item, the current selection is replaced with that item. The ctrl and shift keys can be used to select multiple items.
NoSelection  Items can not be selected


Constructor & Destructor Documentation

DzListBox::DzListBox ( DzWidget  parent  ) 

Creates a list box with the given parent widget


Member Function Documentation

void DzListBox::clear (  ) 

Clears all items in the list box

void DzListBox::clicked ( Number  index,
Point  pnt 
) [signal]

Signature: "clicked(int,const QPoint&)"

Emitted when an item is clicked (mouse button pressed and released).

void DzListBox::clicked ( Number  index  )  [signal]

Signature: "clicked(int)"

Emitted when an item is clicked (mouse button pressed and released).

void DzListBox::contextMenuRequested ( Number  index,
Point  pos 
) [signal]

Signature: "contextMenuRequested(int,const QPoint&)"

Emitted when the user right clicks the list box for a context menu.

void DzListBox::currentChanged ( Number  index  )  [signal]

Signature: "currentChanged(int)"

Emitted when the current item changes.

void DzListBox::doubleClicked ( Number  index  )  [signal]

Signature: "doubleClicked(int)"

Emitted when an item is double clicked.

void DzListBox::highlighted ( String  str  )  [signal]

Signature: "highlighted(const QString&)"

Emitted when the highlighted item changes.

void DzListBox::highlighted ( Number  index  )  [signal]

Signature: "highlighted(int)"

Emitted when the highlighted item changes.

void DzListBox::insertItem ( String  text  ) 

Inserts the given item into the list box

Boolean DzListBox::isSelected ( Number  index  ) 

Returns:
true if the item at the given index is selected

void DzListBox::mouseButtonClicked ( Number  button,
Number  index,
Point  pos 
) [signal]

Signature: "mouseButtonClicked(int,int,const QPoint&)"

Emitted when an item is clicked with the a mouse button (mouse button pressed and released).

void DzListBox::mouseButtonPressed ( Number  button,
Number  index,
Point  pos 
) [signal]

Signature: "mouseButtonPressed(int,int,const QPoint&)"

Emitted when an item is pressed with the a mouse button (mouse button pressed).

void DzListBox::onItem ( Number  index  )  [signal]

Signature: "onItem(int)"

Emitted mouse cursor moves onto an item.

void DzListBox::onViewport (  )  [signal]

Signature: "onViewport()"

Emitted mouse cursor moves from an item to an empty part of the list box.

void DzListBox::pressed ( Number  index,
Point  pnt 
) [signal]

Signature: "pressed(int,const QPoint&)"

Emitted when an item is pressed (mouse button pressed).

void DzListBox::pressed ( Number  index  )  [signal]

Signature: "pressed(int)"

Emitted when an item is pressed (mouse button pressed).

void DzListBox::removeItem ( Number  index  ) 

Removes the given item from the list box

void DzListBox::returnPressed ( Number  index  )  [signal]

Signature: "returnPressed(int)"

Emitted when return is pressed on the current item.

void DzListBox::rightButtonClicked ( Number  index,
Point  pnt 
) [signal]

Signature: "rightButtonClicked(int,const QPoint&)"

Emitted when an item is clicked with the right button (mouse button pressed and released).

void DzListBox::rightButtonPressed ( Number  index,
Point  pnt 
) [signal]

Signature: "rightButtonPressed(int,const QPoint&)"

Emitted when an item is pressed with the right button (mouse button pressed).

void DzListBox::selected ( String  str  )  [signal]

Signature: "selected(const QString&)"

Emitted when the selected item changes.

void DzListBox::selected ( Number  index  )  [signal]

Signature: "selected(int)"

Emitted when the selected item changes.

void DzListBox::selectionChanged ( Number  index  )  [signal]

Signature: "selectionChanged(int)"

Emitted when a new item is selected in single selection mode.

void DzListBox::selectionChanged (  )  [signal]

Signature: "selectionChanged()"

Emitted when the selection in the box changes.

void DzListBox::setSelected ( Number  index,
Boolean  selected 
)

Sets whether the item at the given index is selected

String DzListBox::text ( Number  index  ) 

Returns:
The text of the item at the given index


Member Data Documentation

int DzListBox::columnMode

The layout mode for the columns of the list box

int DzListBox::count

The number of items in the list box (read-only)

int DzListBox::currentItem

The index of the currently highlighted item in the list box

QString DzListBox::currentText

The text of the currently highlighted item in the list box

int DzListBox::numColumns

The number of columns in the list box (read-only)

int DzListBox::numItemsVisible

The number of items visible in the list box (read-only)

int DzListBox::numRows

The number of rows in the list box (read-only)

int DzListBox::rowMode

The layout mode for the rows of the list box

int DzListBox::selected

The index of the currently selected item in the list box (in single selection mode only)

int DzListBox::selectionMode

The selection mode of the list box

int DzListBox::topItem

The index of the item at the top of the list box

bool DzListBox::variableHeight

Whether or not the list box has variable height rows

bool DzListBox::variableWidth

Whether or not the list box has variable width columns


Generated on Thu Sep 24 12:21:13 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.