Package RASCAL.ToolboxTabs

Description	ToolboxTabs related types and methods.
Author	bbracke
Date	2005/11/21 20:14:33
Revision	1.1

Clauses

Quick access : Clauses - Generics - Definitions - Subprograms

Context clauses
System
System.Unsigned_Types
RASCAL.Toolbox
RASCAL.OS

Use clauses
System
System.Unsigned_Types
RASCAL.Toolbox
RASCAL.OS

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Set_State	procedure

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
State	System.Unsigned_Types.unsigned	in
Flags	System.Unsigned_Types.unsigned	in	0

Get_State	function
*Return*	System.Unsigned_Types.unsigned

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Flags	System.Unsigned_Types.unsigned	in	0

Set_Selected	procedure
Equivalent to clicking on the specified tab. Returns an error if the supplied tab index is invalid.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Index	Natural	in out
Flags	System.Unsigned_Types.unsigned	in	0

Get_Selected	function
*Return*	integer

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Flags	System.Unsigned_Types.unsigned	in	0

Get_WindowFromTab	function
*Return*	Object_ID
Returns the window object that a particular tab is associated with. Returns an error if the supplied tab index is invalid.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Index	Natural	in
Flags	System.Unsigned_Types.unsigned	in	0

Get_TabFromWindow	function
*Return*	integer
Returns the index of the tab which has a particular window associated with it. Note that if you use shared window objects, only the first tab to use a particular window will be returned. Returns -1 if the supplied window object id doesn't match any attached to tabs.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Tab_Window	Object_ID	in
Flags	System.Unsigned_Types.unsigned	in	0

Set_Label	procedure
Sets the text for a particular tab. By default the text is the title of the window nested in the tab, but it can be changed with this method. Returns an error if the supplied tab index is invalid.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Index	Natural	in
Text	String	in
Flags	System.Unsigned_Types.unsigned	in	0

Get_Label	function
*Return*	String

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Index	Natural	in
Flags	System.Unsigned_Types.unsigned	in	0