offapi/com/sun/star/frame/FrameSearchFlag.idl

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