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

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