Public Member Functions

workbench_OverviewPanel Class Reference

Inheritance diagram for workbench_OverviewPanel:
GrtObject

List of all members.

Public Member Functions

grt::StringRef caption () const
 Getter for attribute caption.
virtual void caption (const grt::StringRef &value)
 Setter for attribute caption.
grt::IntegerRef expanded () const
 Getter for attribute expanded.
virtual void expanded (const grt::IntegerRef &value)
 Setter for attribute expanded.
grt::IntegerRef expandedHeight () const
 Getter for attribute expandedHeight.
virtual void expandedHeight (const grt::IntegerRef &value)
 Setter for attribute expandedHeight.
grt::IntegerRef hasTabSelection () const
 Getter for attribute hasTabSelection.
virtual void hasTabSelection (const grt::IntegerRef &value)
 Setter for attribute hasTabSelection.
grt::StringRef implModule () const
 Getter for attribute implModule.
virtual void implModule (const grt::StringRef &value)
 Setter for attribute implModule.
grt::StringRef itemActivationFunction () const
 Getter for attribute itemActivationFunction.
virtual void itemActivationFunction (const grt::StringRef &value)
 Setter for attribute itemActivationFunction.
grt::StringRef itemCountFunction () const
 Getter for attribute itemCountFunction.
virtual void itemCountFunction (const grt::StringRef &value)
 Setter for attribute itemCountFunction.
grt::IntegerRef itemDisplayMode () const
 Getter for attribute itemDisplayMode.
virtual void itemDisplayMode (const grt::IntegerRef &value)
 Setter for attribute itemDisplayMode.
grt::StringRef itemInfoFunction () const
 Getter for attribute itemInfoFunction.
virtual void itemInfoFunction (const grt::StringRef &value)
 Setter for attribute itemInfoFunction.
grt::StringRef nodeId () const
 Getter for attribute nodeId.
virtual void nodeId (const grt::StringRef &value)
 Setter for attribute nodeId.
grt::IntegerListRef selectedItems () const
 Getter for attribute selectedItems (read-only).
grt::StringRef tabActivationFunction () const
 Getter for attribute tabActivationFunction.
virtual void tabActivationFunction (const grt::StringRef &value)
 Setter for attribute tabActivationFunction.
grt::StringRef tabCountFunction () const
 Getter for attribute tabCountFunction.
virtual void tabCountFunction (const grt::StringRef &value)
 Setter for attribute tabCountFunction.
grt::StringRef tabInfoFunction () const
 Getter for attribute tabInfoFunction.
virtual void tabInfoFunction (const grt::StringRef &value)
 Setter for attribute tabInfoFunction.

Member Function Documentation

grt::StringRef caption (  )  const

Getter for attribute caption.

the caption displayed on the panel's header

In Python:
value = obj.caption
virtual void caption ( const grt::StringRef &  value  )  [virtual]

Setter for attribute caption.

the caption displayed on the panel's header

In Python:
obj.caption = value
grt::IntegerRef expanded (  )  const

Getter for attribute expanded.

specifies if the panel is currently expanded

In Python:
value = obj.expanded
virtual void expanded ( const grt::IntegerRef &  value  )  [virtual]

Setter for attribute expanded.

specifies if the panel is currently expanded

In Python:
obj.expanded = value
grt::IntegerRef expandedHeight (  )  const

Getter for attribute expandedHeight.

the panel's height when it is expanded

In Python:
value = obj.expandedHeight
virtual void expandedHeight ( const grt::IntegerRef &  value  )  [virtual]

Setter for attribute expandedHeight.

the panel's height when it is expanded

In Python:
obj.expandedHeight = value
grt::IntegerRef hasTabSelection (  )  const

Getter for attribute hasTabSelection.

specifies if the panel has attached tabs

In Python:
value = obj.hasTabSelection
virtual void hasTabSelection ( const grt::IntegerRef &  value  )  [virtual]

Setter for attribute hasTabSelection.

specifies if the panel has attached tabs

In Python:
obj.hasTabSelection = value
grt::StringRef implModule (  )  const

Getter for attribute implModule.

GRT module implementing the item functionality

In Python:
value = obj.implModule
virtual void implModule ( const grt::StringRef &  value  )  [virtual]

Setter for attribute implModule.

GRT module implementing the item functionality

In Python:
obj.implModule = value
grt::StringRef itemActivationFunction (  )  const

Getter for attribute itemActivationFunction.

the function that is called when the item is activated

In Python:
value = obj.itemActivationFunction
virtual void itemActivationFunction ( const grt::StringRef &  value  )  [virtual]

Setter for attribute itemActivationFunction.

the function that is called when the item is activated

In Python:
obj.itemActivationFunction = value
grt::StringRef itemCountFunction (  )  const

Getter for attribute itemCountFunction.

the function that returns the number of items

In Python:
value = obj.itemCountFunction
virtual void itemCountFunction ( const grt::StringRef &  value  )  [virtual]

Setter for attribute itemCountFunction.

the function that returns the number of items

In Python:
obj.itemCountFunction = value
grt::IntegerRef itemDisplayMode (  )  const

Getter for attribute itemDisplayMode.

defines how the items on the panel are displayed. Setting it to 1 will cause a large icon display, 2 a small icon display and 3 a list

In Python:
value = obj.itemDisplayMode
virtual void itemDisplayMode ( const grt::IntegerRef &  value  )  [virtual]

Setter for attribute itemDisplayMode.

defines how the items on the panel are displayed. Setting it to 1 will cause a large icon display, 2 a small icon display and 3 a list

In Python:
obj.itemDisplayMode = value
grt::StringRef itemInfoFunction (  )  const

Getter for attribute itemInfoFunction.

the function that returns the item information

In Python:
value = obj.itemInfoFunction
virtual void itemInfoFunction ( const grt::StringRef &  value  )  [virtual]

Setter for attribute itemInfoFunction.

the function that returns the item information

In Python:
obj.itemInfoFunction = value
virtual void nodeId ( const grt::StringRef &  value  )  [virtual]

Setter for attribute nodeId.

the identifier of panel in the GUI

In Python:
obj.nodeId = value
grt::StringRef nodeId (  )  const

Getter for attribute nodeId.

the identifier of panel in the GUI

In Python:
value = obj.nodeId
grt::IntegerListRef selectedItems (  )  const

Getter for attribute selectedItems (read-only).

specifies the indexes of the currently selected items on the panel

In Python:
value = obj.selectedItems
grt::StringRef tabActivationFunction (  )  const

Getter for attribute tabActivationFunction.

the function that is called when the tab is activated

In Python:
value = obj.tabActivationFunction
virtual void tabActivationFunction ( const grt::StringRef &  value  )  [virtual]

Setter for attribute tabActivationFunction.

the function that is called when the tab is activated

In Python:
obj.tabActivationFunction = value
virtual void tabCountFunction ( const grt::StringRef &  value  )  [virtual]

Setter for attribute tabCountFunction.

the function that returns the number of tabs

In Python:
obj.tabCountFunction = value
grt::StringRef tabCountFunction (  )  const

Getter for attribute tabCountFunction.

the function that returns the number of tabs

In Python:
value = obj.tabCountFunction
grt::StringRef tabInfoFunction (  )  const

Getter for attribute tabInfoFunction.

the function that returns the tab information

In Python:
value = obj.tabInfoFunction
virtual void tabInfoFunction ( const grt::StringRef &  value  )  [virtual]

Setter for attribute tabInfoFunction.

the function that returns the tab information

In Python:
obj.tabInfoFunction = value