Apache OpenOffice Wiki - User contributions [en]

Documentation/DevGuide/Basic/Progress Bar

2009-11-26T03:36:12Z

Azeeman: Sample code works when copied and pasted into Basic

{{Documentation/DevGuide/BasicTOC
|Basic2d=block
|BasicControls=block
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/Basic/Group Box
|NextPage=Documentation/DevGuide/Basic/HorizontalVertical Line
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/Basic/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:Progress Bar}}
The progress bar control <idl>com.sun.star.awt.UnoControlProgressBar</idl> displays a growing or shrinking bar to give the user feedback during an operation, for example, the completion of a lengthy task. The minimum and the maximum progress value of the control is set by the <code>ProgressValueMin</code> and the <code>ProgressValueMax</code> properties. The progress value is controlled by the <code>ProgressValue</code> property. By default, the progress bar is blue, but the fill color can be changed by setting the <code>FillColor</code> property. The functionality of a progress bar is demonstrated in the following example:

<source lang="oobas">
Sub ProgressBarDemo()
Dim oProgressBar as Object, oProgressBarModel As Object, oDialog as Object
Dim ProgressValue As Long
REM Dialog1 contains progress bar ProgressBar1 saved in standard library
DialogLibraries.loadLibrary("Standard")
oDialog = CreateUnoDialog(DialogLibraries.Standard.Dialog1)
REM progress bar settings
Const ProgressValueMin = 0
Const ProgressValueMax = 40
Const ProgressStep = 4
REM set minimum and maximum progress value
oProgressBarModel = oDialog.getModel().getByName( "ProgressBar1" )
oProgressBarModel.setPropertyValue( "ProgressValueMin", ProgressValueMin)
oProgressBarModel.setPropertyValue( "ProgressValueMax", ProgressValueMax)
REM show progress bar
oDialog.setVisible( True )
REM increase progress value every second
For ProgressValue = ProgressValueMin To ProgressValueMax Step ProgressStep
oProgressBarModel.setPropertyValue( "ProgressValue", ProgressValue )
Wait 1000
Next ProgressValue
End Sub
</source>
{{PDL1}}

[[Category:Documentation/Developer's Guide/Basic and Dialogs]]

Documentation/DevGuide/Basic/Progress Bar

2009-11-22T22:46:48Z

Azeeman: Remove button code since it doesn't work and is not needed

{{Documentation/DevGuide/BasicTOC
|Basic2d=block
|BasicControls=block
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/Basic/Group Box
|NextPage=Documentation/DevGuide/Basic/HorizontalVertical Line
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/Basic/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:Progress Bar}}
The progress bar control <idl>com.sun.star.awt.UnoControlProgressBar</idl> displays a growing or shrinking bar to give the user feedback during an operation, for example, the completion of a lengthy task. The minimum and the maximum progress value of the control is set by the <code>ProgressValueMin</code> and the <code>ProgressValueMax</code> properties. The progress value is controlled by the <code>ProgressValue</code> property. By default, the progress bar is blue, but the fill color can be changed by setting the <code>FillColor</code> property. The functionality of a progress bar is demonstrated in the following example:

<source lang="oobas">
Sub ProgressBarDemo()
Dim oProgressBar As Object, oProgressBarModel As Object
Dim ProgressValue As Long
REM progress bar settings
Const ProgressValueMin = 0
Const ProgressValueMax = 40
Const ProgressStep = 4
REM set minimum and maximum progress value
oProgressBarModel = oDialog.Model.ProgressBar1
oProgressBarModel.setRange( ProgressValueMin, ProgressValueMax )
REM show progress bar
oProgressBar = oDialog.getControl("ProgressBar1")
oProgressBar.setVisible( True )
REM increase progress value every second
For ProgressValue =
ProgressValueMin To ProgressValueMax Step ProgressStep
oProgressBarModel.setValue( ProgressValue )
Wait 1000
Next ProgressValue
REM hide progress bar
oProgressBar.setVisible( False )
End Sub
</source>
{{PDL1}}

[[Category:Documentation/Developer's Guide/Basic and Dialogs]]

Documentation/BASIC Guide/Other Functions (Runtime Library)

2009-11-22T21:00:50Z

Azeeman:

{{Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=block
|PrevPage=Documentation/BASIC Guide/Message and Input Boxes (Runtime Library)
|NextPage=Documentation/BASIC Guide/API Intro
|runtime=block
}}
{{DISPLAYTITLE:Other Functions ({{OOo}} Runtime Library)}}
__NOTOC__
== Beep ==

The <tt>Beep</tt> function causes the system to play a sound that can be used to warn the user of an incorrect action. <tt>Beep</tt> does not have any parameters:

<source lang="oobas">
Beep ' creates an informative tone
</source>

== Shell ==

External programs can be started using the Shell function.

<source lang="oobas">
Shell(Pathname, Windowstyle, Param, bSync)
</source>

; Pathname : the path of the program to be executed.
: In MS-Windows, use <tt>ConvertToURL(Pathname)</tt> otherwise the command will not work if <tt>Pathname</tt> contains spaces or national characters.

; Windowstyle : the window in which the program is started.
:The following values are possible:
:* <tt> 0</tt> - The program receives the focus and is started in a concealed window.
:* <tt> 1</tt> - The program receives the focus and is started in a normal-sized window.
:* <tt> 2</tt> - The program receives the focus and is started in a minimized window.
:* <tt> 3</tt> - The program receives the focus and is started in a maximized window.
:* <tt> 4</tt> - The program is started in a normal-sized window, without receiving the focus.
:* <tt> 6</tt> - The program is started in a minimized window, the focus remains in the current window.
:* <tt>10</tt> - The program is started in full screen mode.

; Param : command line parameters to be transferred to the program to be started.

; bSync : wait for shell command to finish flag
:* <tt>true</tt> - wait for shell command to finish
:* <tt>false</tt> - don't wait for shell command to finish

== Wait and WaitUntil ==

The <tt>Wait</tt> statement suspends program execution for a specified time. The waiting period is specified in milliseconds. The command:

<source lang="oobas">
Wait 2000
</source>

specifies a delay of 2 seconds (2000 milliseconds).

The <tt>WaitUntil</tt> statement provides a greater degree of compatibility with VBA parameter usage. <tt>WaitUntil</tt> takes a parameter of type <tt>Date</tt>, with a combined date and time value. The command:

<source lang="oobas">
WaitUntil Now + TimeValue("00:00:02")
</source>

specifies the same delay, 2 seconds, as the previous example.

== Environ ==

The <tt>Environ</tt> function returns the environmental variables of the operating system. Depending on the system and configuration, various types of data are saved here. The following call determines the environment variables of temporary directory of the operating system:

<source lang="oobas">
Dim TempDir
TempDir=Environ ("TEMP")
</source>

{{InterWiki Languages BasicGuide|articletitle=Documentation/BASIC Guide/Other Functions (Runtime Library)}}
{{PDL1}}

Documentation/DevGuide/Basic/Progress Bar

2009-11-22T04:57:57Z

Azeeman:

{{Documentation/DevGuide/BasicTOC
|Basic2d=block
|BasicControls=block
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/Basic/Group Box
|NextPage=Documentation/DevGuide/Basic/HorizontalVertical Line
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/Basic/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:Progress Bar}}
The progress bar control <idl>com.sun.star.awt.UnoControlProgressBar</idl> displays a growing or shrinking bar to give the user feedback during an operation, for example, the completion of a lengthy task. The minimum and the maximum progress value of the control is set by the <code>ProgressValueMin</code> and the <code>ProgressValueMax</code> properties. The progress value is controlled by the <code>ProgressValue</code> property. By default, the progress bar is blue, but the fill color can be changed by setting the <code>FillColor</code> property. The functionality of a progress bar is demonstrated in the following example:

<source lang="oobas">
Sub ProgressBarDemo()
Dim oProgressBar As Object, oProgressBarModel As Object
Dim oCancelButtonModel As Object
Dim oStartButtonModel As Object
Dim ProgressValue As Long
REM progress bar settings
Const ProgressValueMin = 0
Const ProgressValueMax = 40
Const ProgressStep = 4
REM set minimum and maximum progress value
oProgressBarModel = oDialog.Model.ProgressBar1
oProgressBarModel.ProgressValueMin = ProgressValueMin
oProgressBarModel.ProgressValueMax = ProgressValueMax
REM disable cancel and start button
oCancelButtonModel = oDialog.Model.CommandButton1
oCancelButtonModel.Enabled = False
oStartButtonModel = oDialog.Model.CommandButton2
oStartButtonModel.Enabled = False
REM show progress bar
oProgressBar = oDialog.getControl("ProgressBar1")
oProgressBar.setVisible( True )
REM increase progress value every second
For ProgressValue =
ProgressValueMin To ProgressValueMax Step ProgressStep
oProgressBarModel.ProgressValue = ProgressValue
Wait 1000
Next ProgressValue
REM hide progress bar
oProgressBar.setVisible( False )
REM enable cancel and start button
oCancelButtonModel.Enabled = True
oStartButtonModel.Enabled = True
End Sub
</source>
{{PDL1}}

[[Category:Documentation/Developer's Guide/Basic and Dialogs]]

Treecontrol

2009-11-08T00:06:24Z

Azeeman: /* Tree Control Using Basic */

API Preview: file://x|/cl/awt/com/sun/star/awt/tree/module-ix.html

{{Documentation/Note|See also an other documentation [[Going_further_with_Dialog_and_Component#The_New_Tree_Control|here]] in OOoBasic first and then in C++.}}

=== The tree control ===

=== The tree control model ===

=== The tree model ===

The tree control needs a tree model that stores the model information of the entries in the tree.
You can provide your own model which must at least support the interface com.sun.star.awt.XTreeModel.
Or you can use the service DefaultTreeModel which manages a hierarchy of MutableTreeModels.

==== XTreeNode ====

==== Using the DefaultTreeModel ====

<source lang="cpp">
#define O(x) ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( x ) )

Reference< ComponentContext > xCC(...);
Reference< XTreeControlModel > xTreeControlModel(...);

// create the root node with the text value "root node text"

Reference< XMutableTreeNode > xRootNode( MutableTreeNode::create2( xCC, Any( O( "root node text" ) ) ) );

// add two child nodes with text
xRootNode.appendChild( MutableTreeNode::create2( xCC, Any( O( "child 1" ) ) ) );
xRootNode.appendChild( MutableTreeNode::create2( xCC, Any( O( "child 2" ) ) ) );

// create the default tree model with the root node
Reference< XTreeModel > xDefaultTreeModel( DefaultTreeModel::create2( xCC, xRootNode ), UNO_QUERY );

// set the default model at the tree control model
xTreeControlModel->setTreeModel( xDefaultTreeModel );
</source>

=== The tree cell renderer ===

The DefaultTreeCellRenderer renders values with the following types:

# OUString
# sal_Int32, sal_Int16, double, sal_Bool
# ::com::sun::star::awt::XBitmap
# ::com::sun::star::graphics::XGraphic
# ::com::sun::star::awt::XControlModel
# Sequence< T > where T is one of the supported types

==== Using the DefaultTreeCellRenderer ====

<source lang="cpp">
#define O(x) ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( x ) )

Reference< ComponentContext > xCC(...);
Reference< XTreeControlModel > xTreeControlModel(...);

// create the default tree cell renderer and tell him to use images before nodes
Reference< XDefaultTreeCellRenderer > xDefaultRenderer( DefaultTreeCellRenderer::create( xCC ) );
xDefaultRenderer->setExpandedImageURL( O( "expand.png" ) );
xDefaultRenderer->setCollapsedImageURL( O( "collapsed.png" ) );
xDefaultRenderer->setLeafNodeImageURL( O( "leaf.png" ) );

// set the default cell renderer at the tree control model
xTreeControlModel->setCellRenderer( Reference< XTreeCellRenderer >( xDefaultTreeModel, UNO_QUERY ) );
</source>

==== Tree Control Using Basic ====

<source lang="oobas">
REM ***** BASIC *****

'TreeControl using Basic

private oTreeControlDialog as object
public oTreeControl as object
private oMutableTreeDataModel as object
private oTreeModel as object

Sub TreeControl
dim oRoot as object
dim oParent as object
dim oChild as object
dim iLevel as integer
DialogLibraries.loadLibrary("Standard")
'Dialog contains Tree Control with name "TreeControl1
'To use selectionChange listener; selection type must be changed from "none" to "single"
'Dialog also contains button with name "CommandButton1" triggered by mouse pressed event
'to call subprogram OkayButton
oTreeControlDialog = CreateUnoDialog(DialogLibraries.Standard.Dialog1)
'Use mutable tree data model
oMutableTreeDataModel = createUnoService("com.sun.star.awt.tree.MutableTreeDataModel")
'Create root node
oRoot = oMutableTreeDataModel.createNode("Root", true)
'Place node at root of tree
oMutableTreeDataModel.setRoot(oRoot)
'Create tree consisting of parent and four children
oParent = oMutableTreeDataModel.createNode("Parent", true)
'Append four children to parent
'<Tree>
'Parent
' Child 1
' Child 2
' Child 3
' Child 4
'</Tree>
for iLevel = 1 to 4
oParent.appendChild(oMutableTreeDataModel.createNode("Child" & str(iLevel), true))
next iLevel
'Append grandchild to third child. Note that index starts at 0
'<Tree>
'Parent
' Child 1
' Child 2
' Child 3
' Grandchild 1
' Grandchild 2
' Grandchild 3
' Child 4
'</Tree>
'Get third child
oChild = oParent.getChildAt(2)
'Add three grandchildren
for iLevel = 1 to 3
oChild.appendChild(oMutableTreeDataModel.createNode("Grandchild" & str(iLevel), true))
next iLevel
'Add great grandchildren to grandchild 1
'<Tree>
'Parent
' Child 1
' Child 2
' Child 3
' Grandchild 1
' Grandchild 2
' Greatgrandchild 1
' Greatgrandchild 2
' Grandchild 3
' Child 4
'</Tree>
oChild = oParent.getChildAt(2)
oChild = oChild.getChildAt(1)
for iLevel = 1 to 3
oChild.appendChild(oMutableTreeDataModel.createNode("Greatgrandchild" & str(iLevel), true))
next iLevel
'Append tree to root
'<Tree>
'Root
' Parent
' Child 1
' Child 2
' Child 3
' Grandchild 1
' Grandchild 2
' Greatgrandchild 1
' Greatgrandchild 2
' Grandchild 3
' Child 4
'</Tree>
oRoot.appendChild(oParent)
'Insert a new child under Parent
'<Tree>
'Root
' Parent
' Child 1
' Child 2
' Child 3
' Grandchild 1
' Grandchild 2
' Greatgrandchild 1
' Greatgrandchild 2
' Grandchild 3
' Child 4
' Accidental child
'</Tree>
oParent.insertChildByIndex(4,oMutableTreeDataModel.createNode("Accidental child", true)
'Place some data in child 1. Data can be any object; string data is used for simplicity
oChild = oParent.getChildAt(0)
oChild.dataValue = "Some data for child 1"
'Get handle to tree control within dialog
oTreeControl = oTreeControlDialog.getControl("TreeControl1")
'Set tree model to tree control model
oTreeModel = oTreeControl.Model
'Use mutable tree data model
oTreeModel.DataModel = oMutableTreeDataModel
'Start the dialog
oTreeControlDialog.execute()
End Sub

Sub OkayButton
dim oNode as object
'Verify that there is a valid selection
if oTreeControl.selectionCount > 0 then
'Get selected node
oNode = oTreeControl.view.getSelection()
'Show node display value
msgbox("Selected value " & oNode.displayValue)
'Check if node is carrying any data
if not isNull(oNode.dataValue) then
'Display data payload
msgbox("Payload " & oNode.dataValue)
end if
'Kill dialog after node has been selected
oTreeControlDialog.endExecute()
end if
End Sub
</source>

=== The tree cell editor ===

=== The listeners ===

==== XTreeModelListener ====

==== XTreeSelectionListener ====

==== XTreeExpandListener ====

==== XTreeWillExpandListener ====
[[Category:API]]

Treecontrol

2009-11-08T00:05:15Z

Azeeman: /* Example using Basic */

API Preview: file://x|/cl/awt/com/sun/star/awt/tree/module-ix.html

{{Documentation/Note|See also an other documentation [[Going_further_with_Dialog_and_Component#The_New_Tree_Control|here]] in OOoBasic first and then in C++.}}

=== The tree control ===

=== The tree control model ===

=== The tree model ===

The tree control needs a tree model that stores the model information of the entries in the tree.
You can provide your own model which must at least support the interface com.sun.star.awt.XTreeModel.
Or you can use the service DefaultTreeModel which manages a hierarchy of MutableTreeModels.

==== XTreeNode ====

==== Using the DefaultTreeModel ====

<source lang="cpp">
#define O(x) ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( x ) )

Reference< ComponentContext > xCC(...);
Reference< XTreeControlModel > xTreeControlModel(...);

// create the root node with the text value "root node text"

Reference< XMutableTreeNode > xRootNode( MutableTreeNode::create2( xCC, Any( O( "root node text" ) ) ) );

// add two child nodes with text
xRootNode.appendChild( MutableTreeNode::create2( xCC, Any( O( "child 1" ) ) ) );
xRootNode.appendChild( MutableTreeNode::create2( xCC, Any( O( "child 2" ) ) ) );

// create the default tree model with the root node
Reference< XTreeModel > xDefaultTreeModel( DefaultTreeModel::create2( xCC, xRootNode ), UNO_QUERY );

// set the default model at the tree control model
xTreeControlModel->setTreeModel( xDefaultTreeModel );
</source>

=== The tree cell renderer ===

The DefaultTreeCellRenderer renders values with the following types:

# OUString
# sal_Int32, sal_Int16, double, sal_Bool
# ::com::sun::star::awt::XBitmap
# ::com::sun::star::graphics::XGraphic
# ::com::sun::star::awt::XControlModel
# Sequence< T > where T is one of the supported types

==== Using the DefaultTreeCellRenderer ====

<source lang="cpp">
#define O(x) ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( x ) )

Reference< ComponentContext > xCC(...);
Reference< XTreeControlModel > xTreeControlModel(...);

// create the default tree cell renderer and tell him to use images before nodes
Reference< XDefaultTreeCellRenderer > xDefaultRenderer( DefaultTreeCellRenderer::create( xCC ) );
xDefaultRenderer->setExpandedImageURL( O( "expand.png" ) );
xDefaultRenderer->setCollapsedImageURL( O( "collapsed.png" ) );
xDefaultRenderer->setLeafNodeImageURL( O( "leaf.png" ) );

// set the default cell renderer at the tree control model
xTreeControlModel->setCellRenderer( Reference< XTreeCellRenderer >( xDefaultTreeModel, UNO_QUERY ) );
</source>

==== Tree Control Using Basic ====

<source lang="oobas">
REM ***** BASIC *****

'TreeControl using Basic

private oTreeControlDialog as object
public oTreeControl as object
private oMutableTreeDataModel as object
private oTreeModel as object

Sub TreeControl
dim oRoot as object
dim oParent as object
dim oChild as object
dim iLevel as integer
DialogLibraries.loadLibrary("Standard")
'Dialog contains Tree Control with name "TreeControl1
'To use selectionChange listener; selection type must be changed from "none" to "single"
'Dialog also contains button with name "CommandButton1" triggered by mouse pressed event
'to call subprogram OkayButton
oTreeControlDialog = CreateUnoDialog(DialogLibraries.Standard.Dialog1)
'Use mutable tree data model
oMutableTreeDataModel = createUnoService("com.sun.star.awt.tree.MutableTreeDataModel")
'Create root node
oRoot = oMutableTreeDataModel.createNode("Root", true)
'Place node at root of tree
oMutableTreeDataModel.setRoot(oRoot)
'Create tree consisting of parent and four children
oParent = oMutableTreeDataModel.createNode("Parent", true)
'Append four children to parent
'<Tree>
'Parent
' Child 1
' Child 2
' Child 3
' Child 4
'</Tree>
for iLevel = 1 to 4
oParent.appendChild(oMutableTreeDataModel.createNode("Child" & str(iLevel), true))
next iLevel
'Append grandchild to third child. Note that index starts at 0
'<Tree>
'Parent
' Child 1
' Child 2
' Child 3
' Grandchild 1
' Grandchild 2
' Grandchild 3
' Child 4
'</Tree>
'Get third child
oChild = oParent.getChildAt(2)
'Add three grandchildren
for iLevel = 1 to 3
oChild.appendChild(oMutableTreeDataModel.createNode("Grandchild" & str(iLevel), true))
next iLevel
'Add great grandchildren to grandchild 1
'<Tree>
'Parent
' Child 1
' Child 2
' Child 3
' Grandchild 1
' Grandchild 2
' Greatgrandchild 1
' Greatgrandchild 2
' Grandchild 3
' Child 4
'</Tree>
oChild = oParent.getChildAt(2)
oChild = oChild.getChildAt(1)
for iLevel = 1 to 3
oChild.appendChild(oMutableTreeDataModel.createNode("Greatgrandchild" & str(iLevel), true))
next iLevel
'Append tree to root
'<Tree>
'Root
' Parent
' Child 1
' Child 2
' Child 3
' Grandchild 1
' Grandchild 2
' Greatgrandchild 1
' Greatgrandchild 2
' Grandchild 3
' Child 4
'</Tree>
oRoot.appendChild(oParent)
'Insert a new child under Parent
'<Tree>
'Root
' Parent
' Child 1
' Child 2
' Child 3
' Grandchild 1
' Grandchild 2
' Greatgrandchild 1
' Greatgrandchild 2
' Grandchild 3
' Child 4
' Accidental child
'</Tree>
oParent.insertChildByIndex(4,oMutableTreeDataModel.createNode("Accidental child", true)
'Place some data in child 1. Data can be any object; string data is used for simplicity
oChild = oParent.getChildAt(0)
oChild.dataValue = "Some data for child 1"
'Get handle to tree control within dialog
oTreeControl = oTreeControlDialog.getControl("TreeControl1")
'Set tree model to tree control model
oTreeModel = oTreeControl.Model
'Use mutable tree data model
oTreeModel.DataModel = oMutableTreeDataModel
'Start the dialog
oTreeControlDialog.execute()
End Sub

Sub OkayButton
dim oNode as object
'Verify that there is a valid selection
if oTreeControl.selectionCount > 0 then
'Get selected node
oNode = oTreeControl.view.getSelection()
'Show node display value
msgbox("Selected value " & oNode.displayValue)
'Check if node is carrying any data
if not isNull(oNode.dataValue) then
'Display data payload
msgbox("Payload " & oNode.dataValue)
end if
'Kill dialog after node has been selected
oTreeControlDialog.endExecute()
end if
End Sub
</source

=== The tree cell editor ===

=== The listeners ===

==== XTreeModelListener ====

==== XTreeSelectionListener ====

==== XTreeExpandListener ====

==== XTreeWillExpandListener ====
[[Category:API]]

Treecontrol

2009-11-08T00:01:40Z

Azeeman: /* Using the DefaultTreeModel */

API Preview: file://x|/cl/awt/com/sun/star/awt/tree/module-ix.html

{{Documentation/Note|See also an other documentation [[Going_further_with_Dialog_and_Component#The_New_Tree_Control|here]] in OOoBasic first and then in C++.}}

=== The tree control ===

=== The tree control model ===

=== The tree model ===

The tree control needs a tree model that stores the model information of the entries in the tree.
You can provide your own model which must at least support the interface com.sun.star.awt.XTreeModel.
Or you can use the service DefaultTreeModel which manages a hierarchy of MutableTreeModels.

==== XTreeNode ====

==== Using the DefaultTreeModel ====

<source lang="cpp">
#define O(x) ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( x ) )

Reference< ComponentContext > xCC(...);
Reference< XTreeControlModel > xTreeControlModel(...);

// create the root node with the text value "root node text"

Reference< XMutableTreeNode > xRootNode( MutableTreeNode::create2( xCC, Any( O( "root node text" ) ) ) );

// add two child nodes with text
xRootNode.appendChild( MutableTreeNode::create2( xCC, Any( O( "child 1" ) ) ) );
xRootNode.appendChild( MutableTreeNode::create2( xCC, Any( O( "child 2" ) ) ) );

// create the default tree model with the root node
Reference< XTreeModel > xDefaultTreeModel( DefaultTreeModel::create2( xCC, xRootNode ), UNO_QUERY );

// set the default model at the tree control model
xTreeControlModel->setTreeModel( xDefaultTreeModel );
</source>

==== Example using Basic ====

<source lang="oobas">
REM ***** BASIC *****

'TreeControl using Basic

private oTreeControlDialog as object
public oTreeControl as object
private oMutableTreeDataModel as object
private oTreeModel as object

Sub TreeControl
dim oRoot as object
dim oParent as object
dim oChild as object
dim iLevel as integer
DialogLibraries.loadLibrary("Standard")
'Dialog contains Tree Control with name "TreeControl1
'To use selectionChange listener; selection type must be changed from "none" to "single"
'Dialog also contains button with name "CommandButton1" triggered by mouse pressed event
'to call subprogram OkayButton
oTreeControlDialog = CreateUnoDialog(DialogLibraries.Standard.Dialog1)
'Use mutable tree data model
oMutableTreeDataModel = createUnoService("com.sun.star.awt.tree.MutableTreeDataModel")
'Create root node
oRoot = oMutableTreeDataModel.createNode("Root", true)
'Place node at root of tree
oMutableTreeDataModel.setRoot(oRoot)
'Create tree consisting of parent and four children
oParent = oMutableTreeDataModel.createNode("Parent", true)
'Append four children to parent
'<Tree>
'Parent
' Child 1
' Child 2
' Child 3
' Child 4
'</Tree>
for iLevel = 1 to 4
oParent.appendChild(oMutableTreeDataModel.createNode("Child" & str(iLevel), true))
next iLevel
'Append grandchild to third child. Note that index starts at 0
'<Tree>
'Parent
' Child 1
' Child 2
' Child 3
' Grandchild 1
' Grandchild 2
' Grandchild 3
' Child 4
'</Tree>
'Get third child
oChild = oParent.getChildAt(2)
'Add three grandchildren
for iLevel = 1 to 3
oChild.appendChild(oMutableTreeDataModel.createNode("Grandchild" & str(iLevel), true))
next iLevel
'Add great grandchildren to grandchild 1
'<Tree>
'Parent
' Child 1
' Child 2
' Child 3
' Grandchild 1
' Grandchild 2
' Greatgrandchild 1
' Greatgrandchild 2
' Grandchild 3
' Child 4
'</Tree>
oChild = oParent.getChildAt(2)
oChild = oChild.getChildAt(1)
for iLevel = 1 to 3
oChild.appendChild(oMutableTreeDataModel.createNode("Greatgrandchild" & str(iLevel), true))
next iLevel
'Append tree to root
'<Tree>
'Root
' Parent
' Child 1
' Child 2
' Child 3
' Grandchild 1
' Grandchild 2
' Greatgrandchild 1
' Greatgrandchild 2
' Grandchild 3
' Child 4
'</Tree>
oRoot.appendChild(oParent)
'Insert a new child under Parent
'<Tree>
'Root
' Parent
' Child 1
' Child 2
' Child 3
' Grandchild 1
' Grandchild 2
' Greatgrandchild 1
' Greatgrandchild 2
' Grandchild 3
' Child 4
' Accidental child
'</Tree>
oParent.insertChildByIndex(4,oMutableTreeDataModel.createNode("Accidental child", true)
'Place some data in child 1. Data can be any object; string data is used for simplicity
oChild = oParent.getChildAt(0)
oChild.dataValue = "Some data for child 1"
'Get handle to tree control within dialog
oTreeControl = oTreeControlDialog.getControl("TreeControl1")
'Set tree model to tree control model
oTreeModel = oTreeControl.Model
'Use mutable tree data model
oTreeModel.DataModel = oMutableTreeDataModel
'Start the dialog
oTreeControlDialog.execute()
End Sub

Sub OkayButton
dim oNode as object
'Verify that there is a valid selection
if oTreeControl.selectionCount > 0 then
'Get selected node
oNode = oTreeControl.view.getSelection()
'Show node display value
msgbox("Selected value " & oNode.displayValue)
'Check if node is carrying any data
if not isNull(oNode.dataValue) then
'Display data payload
msgbox("Payload " & oNode.dataValue)
end if
'Kill dialog after node has been selected
oTreeControlDialog.endExecute()
end if
End Sub
</source

=== The tree cell renderer ===

The DefaultTreeCellRenderer renders values with the following types:

# OUString
# sal_Int32, sal_Int16, double, sal_Bool
# ::com::sun::star::awt::XBitmap
# ::com::sun::star::graphics::XGraphic
# ::com::sun::star::awt::XControlModel
# Sequence< T > where T is one of the supported types

==== Using the DefaultTreeCellRenderer ====

<source lang="cpp">
#define O(x) ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( x ) )

Reference< ComponentContext > xCC(...);
Reference< XTreeControlModel > xTreeControlModel(...);

// create the default tree cell renderer and tell him to use images before nodes
Reference< XDefaultTreeCellRenderer > xDefaultRenderer( DefaultTreeCellRenderer::create( xCC ) );
xDefaultRenderer->setExpandedImageURL( O( "expand.png" ) );
xDefaultRenderer->setCollapsedImageURL( O( "collapsed.png" ) );
xDefaultRenderer->setLeafNodeImageURL( O( "leaf.png" ) );

// set the default cell renderer at the tree control model
xTreeControlModel->setCellRenderer( Reference< XTreeCellRenderer >( xDefaultTreeModel, UNO_QUERY ) );
</source>

=== The tree cell editor ===

=== The listeners ===

==== XTreeModelListener ====

==== XTreeSelectionListener ====

==== XTreeExpandListener ====

==== XTreeWillExpandListener ====
[[Category:API]]

Treecontrol

2009-11-07T23:57:26Z

Azeeman: /* The tree model */

Treecontrol

2009-11-07T18:22:35Z

Azeeman: /* The tree model */