1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 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_frame_FrameSearchFlag_idl__ 24cdf0e10cSrcweir#define __com_sun_star_frame_FrameSearchFlag_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir 27cdf0e10cSrcweir//============================================================================= 28cdf0e10cSrcweir 29cdf0e10cSrcweir module com { module sun { module star { module frame { 30cdf0e10cSrcweir 31cdf0e10cSrcweir//============================================================================= 32cdf0e10cSrcweir/** these types describe the algorithm to be used to search a frame 33cdf0e10cSrcweir 34cdf0e10cSrcweir <p> 35cdf0e10cSrcweir Such flags will be used on methods <member>XFrame::findFrame()</member>, 36cdf0e10cSrcweir <member>XDispatchProvider::queryDispatch()</member> or 37cdf0e10cSrcweir <member>XComponentLoader::loadComponentFromURL()</member> if no special target 38cdf0e10cSrcweir frame name (e.g. "_blank", "_self") is used. 39cdf0e10cSrcweir </p> 40cdf0e10cSrcweir 41cdf0e10cSrcweir @see XFrame::findFrame() 42cdf0e10cSrcweir @see XDispatchProvider::queryDispatch() 43cdf0e10cSrcweir @see XComponentLoader::loadComponentFromURL() 44cdf0e10cSrcweir */ 45cdf0e10cSrcweirpublished constants FrameSearchFlag 46cdf0e10cSrcweir{ 47cdf0e10cSrcweir //------------------------------------------------------------------------- 48cdf0e10cSrcweir /** no longer supported 49cdf0e10cSrcweir 50cdf0e10cSrcweir <p> 51cdf0e10cSrcweir Using of this flag will do nothing. Use right combination of other flags 52cdf0e10cSrcweir instead of this one. 53cdf0e10cSrcweir </p> 54cdf0e10cSrcweir 55cdf0e10cSrcweir @deprecated 56cdf0e10cSrcweir */ 57cdf0e10cSrcweir const long AUTO = 0; 58cdf0e10cSrcweir 59cdf0e10cSrcweir //------------------------------------------------------------------------- 60cdf0e10cSrcweir /** allows search on the parent frames 61cdf0e10cSrcweir */ 62cdf0e10cSrcweir const long PARENT = 1; 63cdf0e10cSrcweir 64cdf0e10cSrcweir //------------------------------------------------------------------------- 65cdf0e10cSrcweir /** includes the start frame himself 66cdf0e10cSrcweir */ 67cdf0e10cSrcweir const long SELF = 2; 68cdf0e10cSrcweir 69cdf0e10cSrcweir //------------------------------------------------------------------------- 70cdf0e10cSrcweir /** includes all child frames of the start frame 71cdf0e10cSrcweir 72cdf0e10cSrcweir <p> 73cdf0e10cSrcweir Note: That means all direct children and of course her childrens too. 74cdf0e10cSrcweir Search doesn't stop at the next level inside the tree! 75cdf0e10cSrcweir </p> 76cdf0e10cSrcweir */ 77cdf0e10cSrcweir const long CHILDREN = 4; 78cdf0e10cSrcweir 79cdf0e10cSrcweir //------------------------------------------------------------------------- 80cdf0e10cSrcweir /** frame will be created if not found 81cdf0e10cSrcweir */ 82cdf0e10cSrcweir const long CREATE = 8; 83cdf0e10cSrcweir 84cdf0e10cSrcweir //------------------------------------------------------------------------- 85cdf0e10cSrcweir /** includes the direct siblings of the start frame 86cdf0e10cSrcweir 87cdf0e10cSrcweir <p> 88cdf0e10cSrcweir Normaly it's interpreted as search on the direct childs of the parent 89cdf0e10cSrcweir only. But in combination with e.g. the CHILDREN flag it can include all 90cdf0e10cSrcweir children of it too. 91cdf0e10cSrcweir </p> 92cdf0e10cSrcweir */ 93cdf0e10cSrcweir const long SIBLINGS = 16; 94cdf0e10cSrcweir 95cdf0e10cSrcweir //------------------------------------------------------------------------- 96cdf0e10cSrcweir /** allow the search outside the current sub task tree of the whole possible frame tree 97cdf0e10cSrcweir 98cdf0e10cSrcweir <p> 99cdf0e10cSrcweir If this flag isn't present, any search from bottom to top has to stop, if a top frame 100cdf0e10cSrcweir will be reached. It doesn't influence a search from top to bottom. 101cdf0e10cSrcweir But it can be used at the root of the frame tree to search on direct childrens of it only. 102cdf0e10cSrcweir Because the direct children of the root node are the root's of the task sub trees, which 103cdf0e10cSrcweir are top frames too. Instead of using the CHILDREN flag there, it's possible so to supress 104cdf0e10cSrcweir a deeper search so. 105cdf0e10cSrcweir </p> 106cdf0e10cSrcweir */ 107cdf0e10cSrcweir const long TASKS = 32; 108cdf0e10cSrcweir 109cdf0e10cSrcweir //------------------------------------------------------------------------- 110cdf0e10cSrcweir /** includes all frames except frames in other tasks sub trees 111cdf0e10cSrcweir but doesn't create any new frame 112cdf0e10cSrcweir */ 113cdf0e10cSrcweir const long ALL = 23; 114cdf0e10cSrcweir 115cdf0e10cSrcweir //------------------------------------------------------------------------- 116cdf0e10cSrcweir /** searches in the whole hierarchy of frames 117cdf0e10cSrcweir but doesn't create any new frame 118cdf0e10cSrcweir */ 119cdf0e10cSrcweir const long GLOBAL = 55; 120cdf0e10cSrcweir}; 121cdf0e10cSrcweir 122cdf0e10cSrcweir//============================================================================= 123cdf0e10cSrcweir 124cdf0e10cSrcweir}; }; }; }; 125cdf0e10cSrcweir 126cdf0e10cSrcweir#endif 127