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