LibreOffice LibreOffice 24.2 SDK API Reference

Loading...
Searching...
No Matches
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
20
21module com { module sun { module star { module awt { module tree {
22
23
28 interface XTreeControl
29{
39 interface ::com::sun::star::view::XMultiSelectionSupplier;
40
41 // expanding/collapsing/visible
42
55 boolean isNodeExpanded( [in] XTreeNode Node )
56 raises( ::com::sun::star::lang::IllegalArgumentException );
57
70 boolean isNodeCollapsed( [in] XTreeNode Node )
71 raises( ::com::sun::star::lang::IllegalArgumentException );
72
88 void makeNodeVisible( [in] XTreeNode Node )
89 raises( com::sun::star::lang::IllegalArgumentException, ExpandVetoException );
90
100 boolean isNodeVisible( [in] XTreeNode Node )
101 raises( com::sun::star::lang::IllegalArgumentException );
102
116 void expandNode( [in] XTreeNode Node )
117 raises( com::sun::star::lang::IllegalArgumentException, ExpandVetoException );
118
131 void collapseNode( [in] XTreeNode Node )
132 raises( com::sun::star::lang::IllegalArgumentException, ExpandVetoException );
133
140 void addTreeExpansionListener( [in] XTreeExpansionListener Listener );
141
147 void removeTreeExpansionListener( [in] XTreeExpansionListener Listener );
148
154 [attribute] string DefaultExpandedGraphicURL;
155
161 [attribute] string DefaultCollapsedGraphicURL;
162
163 // tree geometry
164
174 XTreeNode getNodeForLocation( [in] long x, [in] long y );
175
188 XTreeNode getClosestNodeForLocation( [in] long x, [in] long y );
189
197 ::com::sun::star::awt::Rectangle
198 getNodeRect( [in] XTreeNode Node )
199 raises( ::com::sun::star::lang::IllegalArgumentException );
200
201 // tree editing
202
209 boolean isEditing();
210
218 boolean stopEditing();
219
223 void cancelEditing();
224
238 void startEditingAtNode( [in] XTreeNode Node )
239 raises( ::com::sun::star::lang::IllegalArgumentException );
240
247 void addTreeEditListener( [in] XTreeEditListener Listener );
248
254 void removeTreeEditListener( [in] XTreeEditListener Listener );
255};
256
257
258}; }; }; }; };
259
260/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::awt::tree::ExpandVetoException
Exception used to stop an expand/collapse from happening.
Definition ExpandVetoException.idl:29
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition IllegalArgumentException.idl:27
com::sun::star::awt::tree::XTreeControl
An interface to a control that displays a set of hierarchical data as an outline.
Definition XTreeControl.idl:29
com::sun::star::awt::tree::XTreeControl::cancelEditing
void cancelEditing()
Cancels the current editing session.
com::sun::star::awt::tree::XTreeControl::addTreeExpansionListener
void addTreeExpansionListener([in] XTreeExpansionListener Listener)
Adds a listener for TreeExpansion events.
com::sun::star::awt::tree::XTreeControl::makeNodeVisible
void makeNodeVisible([in] XTreeNode Node)
Ensures that Node is currently visible.
com::sun::star::awt::tree::XTreeControl::isNodeCollapsed
boolean isNodeCollapsed([in] XTreeNode Node)
Returns TRUE if Node is currently collapsed.
com::sun::star::awt::tree::XTreeControl::startEditingAtNode
void startEditingAtNode([in] XTreeNode Node)
Selects Node and initiates editing.
com::sun::star::awt::tree::XTreeControl::DefaultCollapsedGraphicURL
string DefaultCollapsedGraphicURL
If the given URL points to a loadable graphic, the graphic is rendered before collapsed non leaf node...
Definition XTreeControl.idl:161
com::sun::star::awt::tree::XTreeControl::collapseNode
void collapseNode([in] XTreeNode Node)
Ensures that Node is collapsed.
com::sun::star::awt::tree::XTreeControl::removeTreeEditListener
void removeTreeEditListener([in] XTreeEditListener Listener)
Removes a XTreeEditListener.
com::sun::star::awt::tree::XTreeControl::DefaultExpandedGraphicURL
string DefaultExpandedGraphicURL
If the given URL points to a loadable graphic, the graphic is rendered before expanded non leaf nodes...
Definition XTreeControl.idl:154
com::sun::star::awt::tree::XTreeControl::getNodeRect
::com::sun::star::awt::Rectangle getNodeRect([in] XTreeNode Node)
returns the rectangle occupied by the visual representation of the given node
com::sun::star::awt::tree::XTreeControl::stopEditing
boolean stopEditing()
Ends the current editing session.
com::sun::star::awt::tree::XTreeControl::isEditing
boolean isEditing()
Returns TRUE if one of tree's nodes is being currently edited.
com::sun::star::awt::tree::XTreeControl::getClosestNodeForLocation
XTreeNode getClosestNodeForLocation([in] long x, [in] long y)
Returns the node that is closest to x,y.
com::sun::star::awt::tree::XTreeControl::expandNode
void expandNode([in] XTreeNode Node)
Ensures that Node is expanded and visible.
com::sun::star::awt::tree::XTreeControl::isNodeVisible
boolean isNodeVisible([in] XTreeNode Node)
Returns TRUE if Node is currently visible.
com::sun::star::awt::tree::XTreeControl::addTreeEditListener
void addTreeEditListener([in] XTreeEditListener Listener)
Adds a XTreeEditListener.
com::sun::star::awt::tree::XTreeControl::isNodeExpanded
boolean isNodeExpanded([in] XTreeNode Node)
Returns TRUE if Node is currently expanded.
com::sun::star::awt::tree::XTreeControl::getNodeForLocation
XTreeNode getNodeForLocation([in] long x, [in] long y)
Returns the node at the specified location.
com::sun::star::awt::tree::XTreeControl::removeTreeExpansionListener
void removeTreeExpansionListener([in] XTreeExpansionListener Listener)
Removes a listener for TreeExpansion events.
com::sun::star::awt::tree::XTreeEditListener
You can implement this interface and register with XTreeControl::addTreeEditListener() to get notific...
Definition XTreeEditListener.idl:31
com::sun::star::awt::tree::XTreeExpansionListener
An instance of this interface can get notifications from a TreeControl when nodes are expanded or col...
Definition XTreeExpansionListener.idl:31
com::sun::star::awt::tree::XTreeNode
An instance implementing this interface represents the model data for an entry in a XTreeDataModel.
Definition XTreeNode.idl:31
com
Definition Ambiguous.idl:20
com::sun::star::awt::Rectangle
specifies a rectangular area by position and size.
Definition Rectangle.idl:28