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_ucb_HierarchyDataReadAccess_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_ucb_HierarchyDataReadAccess_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XNameAccess_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XNameAccess.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XHierarchicalNameAccess_idl__ 30*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XHierarchicalNameAccess.idl> 31*b1cdbd2cSJim Jagielski#endif 32*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_util_XChangesNotifier_idl__ 33*b1cdbd2cSJim Jagielski#include <com/sun/star/util/XChangesNotifier.idl> 34*b1cdbd2cSJim Jagielski#endif 35*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_XComponent_idl__ 36*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/XComponent.idl> 37*b1cdbd2cSJim Jagielski#endif 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski//============================================================================= 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module ucb { 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski//============================================================================= 44*b1cdbd2cSJim Jagielski/** provides read access to a fragment of the hierarchy data. 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski <p>A hierarchy data source provides access to a tree of hierarchy data 47*b1cdbd2cSJim Jagielski nodes. Each hierarchy data node, except the root node, has a parent that 48*b1cdbd2cSJim Jagielski is a hierarchy data node too. A hierarchy data node has a name. 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski <p>Each hierarchy data node has three data members: 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski <ul> 53*b1cdbd2cSJim Jagielski <li>"Title", which is of type <atom>string</atom>. It contains a title 54*b1cdbd2cSJim Jagielski for the node. This value must not be empty. 55*b1cdbd2cSJim Jagielski <li>"TargetURL", which is of type <atom>string</atom></li> It may contain 56*b1cdbd2cSJim Jagielski any URL, which will be treated as the target of a hierarchy link. 57*b1cdbd2cSJim Jagielski <li>"Children", which is of type <type>HierarchyDataReadAccess</type> or 58*b1cdbd2cSJim Jagielski of type <type>HierarchyDataReadWriteAccess</type></li>, depending on the 59*b1cdbd2cSJim Jagielski type of the node. This member provides access to the children of a node. 60*b1cdbd2cSJim Jagielski </ul> 61*b1cdbd2cSJim Jagielski*/ 62*b1cdbd2cSJim Jagielskipublished service HierarchyDataReadAccess 63*b1cdbd2cSJim Jagielski{ 64*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 65*b1cdbd2cSJim Jagielski /** gives access to the data members of a hierarchy data node. 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski <p>Examples: 68*b1cdbd2cSJim Jagielski <ul> 69*b1cdbd2cSJim Jagielski <li><code>getByName( "Title" )</code> will return an <atom>any</atom> 70*b1cdbd2cSJim Jagielski containing a string containing the title of the node. 71*b1cdbd2cSJim Jagielski </li> 72*b1cdbd2cSJim Jagielski <li><code>getByName( "Children" )</code> will return an <atom>any</atom> 73*b1cdbd2cSJim Jagielski containing an implementation of service 74*b1cdbd2cSJim Jagielski <type>HierarchyDataReadAccess</type>, if it was called on a read-only 75*b1cdbd2cSJim Jagielski node. It will return an implementation of service 76*b1cdbd2cSJim Jagielski <type>HierarchyDataReadWriteAccess</type> if it was called on a 77*b1cdbd2cSJim Jagielski writable node. 78*b1cdbd2cSJim Jagielski </li> 79*b1cdbd2cSJim Jagielski </ul> 80*b1cdbd2cSJim Jagielski */ 81*b1cdbd2cSJim Jagielski interface com::sun::star::container::XNameAccess; 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 84*b1cdbd2cSJim Jagielski /** gives access to the data members of a hierarchy data node as well 85*b1cdbd2cSJim Jagielski as to any child nodes or to the data members of child nodes using a 86*b1cdbd2cSJim Jagielski hierarchical name. 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski <p>A hierarchical name consists of segments that are separated by a 89*b1cdbd2cSJim Jagielski single slash ('/'). There is neither a leading nor a trailing slash 90*b1cdbd2cSJim Jagielski allowed. 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski <ul> 93*b1cdbd2cSJim Jagielski <li> 94*b1cdbd2cSJim Jagielski path = segment ( '/' segement )* 95*b1cdbd2cSJim Jagielski </li> 96*b1cdbd2cSJim Jagielski <li> 97*b1cdbd2cSJim Jagielski segment = '[' quoted-string ']' 98*b1cdbd2cSJim Jagielski </li> 99*b1cdbd2cSJim Jagielski <li> 100*b1cdbd2cSJim Jagielski quoted-string = "'" escaped-string "'" 101*b1cdbd2cSJim Jagielski </li> 102*b1cdbd2cSJim Jagielski <li> 103*b1cdbd2cSJim Jagielski escaped-string = escaped accoding to XML attribute naming conventions 104*b1cdbd2cSJim Jagielski </li> 105*b1cdbd2cSJim Jagielski </ul> 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski <p>Examples: 108*b1cdbd2cSJim Jagielski <ul> 109*b1cdbd2cSJim Jagielski <li> 110*b1cdbd2cSJim Jagielski <code>getByHierarchicalName( "Title" )</code> will return an 111*b1cdbd2cSJim Jagielski <atom>any</atom> containing a string containing the title of the node 112*b1cdbd2cSJim Jagielski itself. 113*b1cdbd2cSJim Jagielski </li> 114*b1cdbd2cSJim Jagielski <li> 115*b1cdbd2cSJim Jagielski <code>getByHierarchicalName( "Children/['subnode1']" )</code> will give 116*b1cdbd2cSJim Jagielski access to the child node named "subnode1" of the node. It will return 117*b1cdbd2cSJim Jagielski an <atom>any</atom> containing an implementation of service 118*b1cdbd2cSJim Jagielski <type>HierarchyDataReadAccess</type>, if it was called on a read-only 119*b1cdbd2cSJim Jagielski node. It will return an implementation of service 120*b1cdbd2cSJim Jagielski <type>HierarchyDataReadWriteAccess</type> if it was called on a 121*b1cdbd2cSJim Jagielski writable node. 122*b1cdbd2cSJim Jagielski </li> 123*b1cdbd2cSJim Jagielski <li> 124*b1cdbd2cSJim Jagielski <code>getByHierarchicalName( "Children/['subnode2']/TargetURL" )</code> 125*b1cdbd2cSJim Jagielski will give direct access to the "TargetURL" data member of the child node 126*b1cdbd2cSJim Jagielski named "subnode2" of the node. It will return an <atom>any</atom> 127*b1cdbd2cSJim Jagielski containing a <atom>string</atom> containing the target URL of the node. 128*b1cdbd2cSJim Jagielski </li> 129*b1cdbd2cSJim Jagielski <li> 130*b1cdbd2cSJim Jagielski <code>getByHierarchicalName( "Children/['subnode3']/Children" )</code> 131*b1cdbd2cSJim Jagielski will give direct access to the "Children" data member of the child node 132*b1cdbd2cSJim Jagielski named "subnode3" of the node. It will return an <atom>any</atom> 133*b1cdbd2cSJim Jagielski conntaining an implementation of service 134*b1cdbd2cSJim Jagielski <type>HierarchyDataReadAccess</type>, if it was called on a read-only 135*b1cdbd2cSJim Jagielski node. It will return an implementation of service 136*b1cdbd2cSJim Jagielski <type>HierarchyDataReadWriteAccess</type> if it was called on a 137*b1cdbd2cSJim Jagielski writable node. 138*b1cdbd2cSJim Jagielski </li> 139*b1cdbd2cSJim Jagielski </ul> 140*b1cdbd2cSJim Jagielski */ 141*b1cdbd2cSJim Jagielski interface com::sun::star::container::XHierarchicalNameAccess; 142*b1cdbd2cSJim Jagielski 143*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 144*b1cdbd2cSJim Jagielski /** allows registering listeners that observe the hierarchy data source. 145*b1cdbd2cSJim Jagielski 146*b1cdbd2cSJim Jagielski <p>A client can register an 147*b1cdbd2cSJim Jagielski <type scope="com::sun::star::util">XChangesListener</type>, which will 148*b1cdbd2cSJim Jagielski receive notifications for any changes within the hierarchy (fragment) 149*b1cdbd2cSJim Jagielski this object represents. 150*b1cdbd2cSJim Jagielski 151*b1cdbd2cSJim Jagielski <p>An implementation should collect as many changes as possible into a 152*b1cdbd2cSJim Jagielski single <type scope="com::sun::star::util">ChangesEvent</type>. 153*b1cdbd2cSJim Jagielski */ 154*b1cdbd2cSJim Jagielski interface com::sun::star::util::XChangesNotifier; 155*b1cdbd2cSJim Jagielski 156*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 157*b1cdbd2cSJim Jagielski /** allows controlling or observing the lifetime of the hierarchy data 158*b1cdbd2cSJim Jagielski access object. 159*b1cdbd2cSJim Jagielski */ 160*b1cdbd2cSJim Jagielski interface com::sun::star::lang::XComponent; 161*b1cdbd2cSJim Jagielski}; 162*b1cdbd2cSJim Jagielski 163*b1cdbd2cSJim Jagielski//============================================================================= 164*b1cdbd2cSJim Jagielski 165*b1cdbd2cSJim Jagielski}; }; }; }; 166*b1cdbd2cSJim Jagielski 167*b1cdbd2cSJim Jagielski#endif 168