1*d1766043SAndrew Rist/************************************************************** 2*d1766043SAndrew Rist * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_awt_tree_XTreeNode_idl__ 24cdf0e10cSrcweir#define __com_sun_star_awt_tree_XTreeNode_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_container_XEnumerationAccess_idl__ 27cdf0e10cSrcweir#include <com/sun/star/container/XEnumerationAccess.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef _com_sun_star_lang_IndexOutOfBoundsException_idl_ 31cdf0e10cSrcweir#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir//============================================================================= 35cdf0e10cSrcweir 36cdf0e10cSrcweirmodule com { module sun { module star { module awt { module tree { 37cdf0e10cSrcweir 38cdf0e10cSrcweir//============================================================================= 39cdf0e10cSrcweir 40cdf0e10cSrcweir/** An instance implementing this interface represents the model data for an entry in a 41cdf0e10cSrcweir <type>XTreeDataModel</type>. 42cdf0e10cSrcweir <p>The <type>TreeControl</type> uses this interface to retrieve the model 43cdf0e10cSrcweir information needed to display a hierarchical outline</p> 44cdf0e10cSrcweir <p>Each XTreeNode in a <type>XTreeDataModel</type> must be unique. 45cdf0e10cSrcweir */ 46cdf0e10cSrcweirpublished interface XTreeNode 47cdf0e10cSrcweir{ 48cdf0e10cSrcweir /** Returns the child tree node at <var>Index</var>. 49cdf0e10cSrcweir 50cdf0e10cSrcweir @throws ::com::sun::star::lang::IndexOutOfBoundsException 51cdf0e10cSrcweir if <var>Index</var> is less than 0 or equal or greater then <member>getChildCount</member>. 52cdf0e10cSrcweir */ 53cdf0e10cSrcweir XTreeNode getChildAt( [in] long Index ) 54cdf0e10cSrcweir raises( com::sun::star::lang::IndexOutOfBoundsException ); 55cdf0e10cSrcweir 56cdf0e10cSrcweir /** Returns the number of child nodes. */ 57cdf0e10cSrcweir long getChildCount(); 58cdf0e10cSrcweir 59cdf0e10cSrcweir /** Returns the parent node of this node. */ 60cdf0e10cSrcweir XTreeNode getParent(); 61cdf0e10cSrcweir 62cdf0e10cSrcweir /** Returns the index of <var>Node</Node> in this instances children. 63cdf0e10cSrcweir @returns 64cdf0e10cSrcweir The child index of <var>Node</Node> , or -1 if <var>Node</Node> is no child of this instance. 65cdf0e10cSrcweir */ 66cdf0e10cSrcweir long getIndex( [in] XTreeNode Node); 67cdf0e10cSrcweir 68cdf0e10cSrcweir /** Returns <TRUE/> if the children of this node are created on demand. 69cdf0e10cSrcweir <p>A <type>TreeControl</type> will handle a node that returns <TRUE/> always 70cdf0e10cSrcweir like a node that has child nodes, even if <member>getChildCount</member> 71cdf0e10cSrcweir returns 0.</p> 72cdf0e10cSrcweir 73cdf0e10cSrcweir @see TreeExpansionListener; 74cdf0e10cSrcweir */ 75cdf0e10cSrcweir boolean hasChildrenOnDemand(); 76cdf0e10cSrcweir 77cdf0e10cSrcweir /** If not empty, the textual representation of this any is used as the text part of this node. 78cdf0e10cSrcweir */ 79cdf0e10cSrcweir any getDisplayValue(); 80cdf0e10cSrcweir 81cdf0e10cSrcweir /** The URL for a graphic that is rendered before the text part of this node. 82cdf0e10cSrcweir <p>If this URL is empty, no graphic is rendered. 83cdf0e10cSrcweir */ 84cdf0e10cSrcweir string getNodeGraphicURL(); 85cdf0e10cSrcweir 86cdf0e10cSrcweir /** The URL for a graphic that is rendered to visualize expanded non leaf nodes. 87cdf0e10cSrcweir <p>If <var>URL</var> is empty, <member>XTreeControl::DefaultExpandedGraphicURL</member> is used. 88cdf0e10cSrcweir */ 89cdf0e10cSrcweir string getExpandedGraphicURL(); 90cdf0e10cSrcweir 91cdf0e10cSrcweir /** The URL for a graphic that is rendered to visualize collapsed non leaf nodes. 92cdf0e10cSrcweir <p>If <var>URL</var> is empty, <member>XTreeControl::DefaultCollapsedGraphicURL</member> is used. 93cdf0e10cSrcweir */ 94cdf0e10cSrcweir string getCollapsedGraphicURL(); 95cdf0e10cSrcweir}; 96cdf0e10cSrcweir 97cdf0e10cSrcweir//============================================================================= 98cdf0e10cSrcweir 99cdf0e10cSrcweir}; }; }; }; }; 100cdf0e10cSrcweir 101cdf0e10cSrcweir#endif 102