1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_frame_XFrames_idl__ 24#define __com_sun_star_frame_XFrames_idl__ 25 26#ifndef __com_sun_star_container_XIndexAccess_idl__ 27#include <com/sun/star/container/XIndexAccess.idl> 28#endif 29 30#ifndef __com_sun_star_frame_XFrame_idl__ 31#include <com/sun/star/frame/XFrame.idl> 32#endif 33 34 35//============================================================================= 36 37 module com { module sun { module star { module frame { 38 39//============================================================================= 40/** manages and creates frames. 41 42 <p> 43 Frames may contain other frames (by implementing an <type>XFrames</type> 44 interface) and may be contained in other frames. 45 </p> 46 47 @see XFrame 48 @see Frame 49 */ 50published interface XFrames: com::sun::star::container::XIndexAccess 51{ 52 //------------------------------------------------------------------------- 53 /** appends the specified <type>Frame</type> to the list of sub-frames. 54 55 @param xFrame 56 new frame for inserting into this container 57 */ 58 void append( [in] XFrame xFrame ); 59 60 //------------------------------------------------------------------------- 61 /** provides access to the list of all currently existing 62 frames inside this container and her sub frames 63 64 @param nSearchFlags 65 use combinations of <type>FrameSearchFlag</type> to specify which 66 frames should be found 67 68 @return 69 all frames of this container and all available frames of the whole frame tree 70 which match search parameter <var>SearchFlags</var> 71 */ 72 sequence< XFrame > queryFrames( [in] long nSearchFlags ); 73 74 //------------------------------------------------------------------------- 75 /** removes the frame from its container. 76 77 <p> 78 Note: 79 <ul> 80 <li>The method <method>XComponent::dispose()</method> is not called implicitly 81 by this method.</li> 82 <li>The creator attribute of the frame must be reset by the caller of 83 this method.</li> 84 </ul> 85 </p> 86 87 @param xFrame 88 frame which should be removed from this container 89 */ 90 void remove( [in] XFrame xFrame ); 91 92}; 93 94//============================================================================= 95 96}; }; }; }; 97 98#endif 99