1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_frame_FrameSearchFlag_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_frame_FrameSearchFlag_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir//============================================================================= 32*cdf0e10cSrcweir 33*cdf0e10cSrcweir module com { module sun { module star { module frame { 34*cdf0e10cSrcweir 35*cdf0e10cSrcweir//============================================================================= 36*cdf0e10cSrcweir/** these types describe the algorithm to be used to search a frame 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir <p> 39*cdf0e10cSrcweir Such flags will be used on methods <member>XFrame::findFrame()</member>, 40*cdf0e10cSrcweir <member>XDispatchProvider::queryDispatch()</member> or 41*cdf0e10cSrcweir <member>XComponentLoader::loadComponentFromURL()</member> if no special target 42*cdf0e10cSrcweir frame name (e.g. "_blank", "_self") is used. 43*cdf0e10cSrcweir </p> 44*cdf0e10cSrcweir 45*cdf0e10cSrcweir @see XFrame::findFrame() 46*cdf0e10cSrcweir @see XDispatchProvider::queryDispatch() 47*cdf0e10cSrcweir @see XComponentLoader::loadComponentFromURL() 48*cdf0e10cSrcweir */ 49*cdf0e10cSrcweirpublished constants FrameSearchFlag 50*cdf0e10cSrcweir{ 51*cdf0e10cSrcweir //------------------------------------------------------------------------- 52*cdf0e10cSrcweir /** no longer supported 53*cdf0e10cSrcweir 54*cdf0e10cSrcweir <p> 55*cdf0e10cSrcweir Using of this flag will do nothing. Use right combination of other flags 56*cdf0e10cSrcweir instead of this one. 57*cdf0e10cSrcweir </p> 58*cdf0e10cSrcweir 59*cdf0e10cSrcweir @deprecated 60*cdf0e10cSrcweir */ 61*cdf0e10cSrcweir const long AUTO = 0; 62*cdf0e10cSrcweir 63*cdf0e10cSrcweir //------------------------------------------------------------------------- 64*cdf0e10cSrcweir /** allows search on the parent frames 65*cdf0e10cSrcweir */ 66*cdf0e10cSrcweir const long PARENT = 1; 67*cdf0e10cSrcweir 68*cdf0e10cSrcweir //------------------------------------------------------------------------- 69*cdf0e10cSrcweir /** includes the start frame himself 70*cdf0e10cSrcweir */ 71*cdf0e10cSrcweir const long SELF = 2; 72*cdf0e10cSrcweir 73*cdf0e10cSrcweir //------------------------------------------------------------------------- 74*cdf0e10cSrcweir /** includes all child frames of the start frame 75*cdf0e10cSrcweir 76*cdf0e10cSrcweir <p> 77*cdf0e10cSrcweir Note: That means all direct children and of course her childrens too. 78*cdf0e10cSrcweir Search doesn't stop at the next level inside the tree! 79*cdf0e10cSrcweir </p> 80*cdf0e10cSrcweir */ 81*cdf0e10cSrcweir const long CHILDREN = 4; 82*cdf0e10cSrcweir 83*cdf0e10cSrcweir //------------------------------------------------------------------------- 84*cdf0e10cSrcweir /** frame will be created if not found 85*cdf0e10cSrcweir */ 86*cdf0e10cSrcweir const long CREATE = 8; 87*cdf0e10cSrcweir 88*cdf0e10cSrcweir //------------------------------------------------------------------------- 89*cdf0e10cSrcweir /** includes the direct siblings of the start frame 90*cdf0e10cSrcweir 91*cdf0e10cSrcweir <p> 92*cdf0e10cSrcweir Normaly it's interpreted as search on the direct childs of the parent 93*cdf0e10cSrcweir only. But in combination with e.g. the CHILDREN flag it can include all 94*cdf0e10cSrcweir children of it too. 95*cdf0e10cSrcweir </p> 96*cdf0e10cSrcweir */ 97*cdf0e10cSrcweir const long SIBLINGS = 16; 98*cdf0e10cSrcweir 99*cdf0e10cSrcweir //------------------------------------------------------------------------- 100*cdf0e10cSrcweir /** allow the search outside the current sub task tree of the whole possible frame tree 101*cdf0e10cSrcweir 102*cdf0e10cSrcweir <p> 103*cdf0e10cSrcweir If this flag isn't present, any search from bottom to top has to stop, if a top frame 104*cdf0e10cSrcweir will be reached. It doesn't influence a search from top to bottom. 105*cdf0e10cSrcweir But it can be used at the root of the frame tree to search on direct childrens of it only. 106*cdf0e10cSrcweir Because the direct children of the root node are the root's of the task sub trees, which 107*cdf0e10cSrcweir are top frames too. Instead of using the CHILDREN flag there, it's possible so to supress 108*cdf0e10cSrcweir a deeper search so. 109*cdf0e10cSrcweir </p> 110*cdf0e10cSrcweir */ 111*cdf0e10cSrcweir const long TASKS = 32; 112*cdf0e10cSrcweir 113*cdf0e10cSrcweir //------------------------------------------------------------------------- 114*cdf0e10cSrcweir /** includes all frames except frames in other tasks sub trees 115*cdf0e10cSrcweir but doesn't create any new frame 116*cdf0e10cSrcweir */ 117*cdf0e10cSrcweir const long ALL = 23; 118*cdf0e10cSrcweir 119*cdf0e10cSrcweir //------------------------------------------------------------------------- 120*cdf0e10cSrcweir /** searches in the whole hierarchy of frames 121*cdf0e10cSrcweir but doesn't create any new frame 122*cdf0e10cSrcweir */ 123*cdf0e10cSrcweir const long GLOBAL = 55; 124*cdf0e10cSrcweir}; 125*cdf0e10cSrcweir 126*cdf0e10cSrcweir//============================================================================= 127*cdf0e10cSrcweir 128*cdf0e10cSrcweir}; }; }; }; 129*cdf0e10cSrcweir 130*cdf0e10cSrcweir#endif 131