LibreOffice
LibreOffice 7.3 SDK API Reference
XTreeControl.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 #ifndef __com_sun_star_awt_tree_XTreeControl_idl__
20 #define __com_sun_star_awt_tree_XTreeControl_idl__
21 
26 
27 
28 module com { module sun { module star { module awt { module tree {
29 
30 
35 interface XTreeControl
36 {
46  interface ::com::sun::star::view::XMultiSelectionSupplier;
47 
48  // expanding/collapsing/visible
49 
62  boolean isNodeExpanded( [in] XTreeNode Node )
64 
77  boolean isNodeCollapsed( [in] XTreeNode Node )
79 
95  void makeNodeVisible( [in] XTreeNode Node )
97 
107  boolean isNodeVisible( [in] XTreeNode Node )
109 
123  void expandNode( [in] XTreeNode Node )
125 
138  void collapseNode( [in] XTreeNode Node )
140 
148 
155 
161  [attribute] string DefaultExpandedGraphicURL;
162 
168  [attribute] string DefaultCollapsedGraphicURL;
169 
170  // tree geometry
171 
181  XTreeNode getNodeForLocation( [in] long x, [in] long y );
182 
195  XTreeNode getClosestNodeForLocation( [in] long x, [in] long y );
196 
205  getNodeRect( [in] XTreeNode Node )
207 
208  // tree editing
209 
216  boolean isEditing();
217 
225  boolean stopEditing();
226 
231 
245  void startEditingAtNode( [in] XTreeNode Node )
247 
254  void addTreeEditListener( [in] XTreeEditListener Listener );
255 
262 };
263 
264 
265 }; }; }; }; };
266 
267 #endif
268 
269 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Exception used to stop an expand/collapse from happening.
Definition: ExpandVetoException.idl:34
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
An interface to a control that displays a set of hierarchical data as an outline.
Definition: XTreeControl.idl:36
void cancelEditing()
Cancels the current editing session.
void addTreeExpansionListener([in] XTreeExpansionListener Listener)
Adds a listener for TreeExpansion events.
void makeNodeVisible([in] XTreeNode Node)
Ensures that Node is currently visible.
boolean isNodeCollapsed([in] XTreeNode Node)
Returns TRUE if Node is currently collapsed.
void startEditingAtNode([in] XTreeNode Node)
Selects Node and initiates editing.
string DefaultCollapsedGraphicURL
If the given URL points to a loadable graphic, the graphic is rendered before collapsed non leaf node...
Definition: XTreeControl.idl:168
void collapseNode([in] XTreeNode Node)
Ensures that Node is collapsed.
void removeTreeEditListener([in] XTreeEditListener Listener)
Removes a XTreeEditListener.
string DefaultExpandedGraphicURL
If the given URL points to a loadable graphic, the graphic is rendered before expanded non leaf nodes...
Definition: XTreeControl.idl:161
::com::sun::star::awt::Rectangle getNodeRect([in] XTreeNode Node)
returns the rectangle occupied by the visual representation of the given node
boolean stopEditing()
Ends the current editing session.
boolean isEditing()
Returns TRUE if one of tree's nodes is being currently edited.
XTreeNode getClosestNodeForLocation([in] long x, [in] long y)
Returns the node that is closest to x,y.
void expandNode([in] XTreeNode Node)
Ensures that Node is expanded and visible.
boolean isNodeVisible([in] XTreeNode Node)
Returns TRUE if Node is currently visible.
void addTreeEditListener([in] XTreeEditListener Listener)
Adds a XTreeEditListener.
boolean isNodeExpanded([in] XTreeNode Node)
Returns TRUE if Node is currently expanded.
XTreeNode getNodeForLocation([in] long x, [in] long y)
Returns the node at the specified location.
void removeTreeExpansionListener([in] XTreeExpansionListener Listener)
Removes a listener for TreeExpansion events.
You can implement this interface and register with XTreeControl::addTreeEditListener() to get notific...
Definition: XTreeEditListener.idl:37
An instance of this interface can get notifications from a TreeControl when nodes are expanded or col...
Definition: XTreeExpansionListener.idl:38
An instance implementing this interface represents the model data for an entry in a XTreeDataModel.
Definition: XTreeNode.idl:36
Definition: Ambiguous.idl:22
specifies a rectangular area by position and size.
Definition: Rectangle.idl:30