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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22  module com {  module sun {  module star {  module frame {
  23
  24 /** these types describe the algorithm to be used to search a frame
  25
  26     <p>
  27     Such flags will be used on methods XFrame::findFrame(),
  28     XDispatchProvider::queryDispatch() or
  29     XComponentLoader::loadComponentFromURL() if no special target
  30     frame name (e.g. "_blank", "_self") is used.
  31     </p>
  32
  33     @see XFrame::findFrame()
  34     @see XDispatchProvider::queryDispatch()
  35     @see XComponentLoader::loadComponentFromURL()
  36  */
  37 published constants FrameSearchFlag
  38 {
  39     /** no longer supported
  40
  41         <p>
  42         Using of this flag will do nothing. Use right combination of other flags
  43         instead of this one.
  44         </p>
  45
  46         @deprecated
  47      */
  48     const long AUTO = 0;
  49
  50     /** allows search on the parent frames
  51      */
  52     const long PARENT = 1;
  53
  54     /** includes the start frame himself
  55      */
  56     const long SELF = 2;
  57
  58         /** includes all child frames of the start frame
  59
  60             <p>
  61             Note: That means all direct children and of course her children too.
  62                   Search doesn't stop at the next level inside the tree!
  63             </p>
  64          */
  65     const long CHILDREN = 4;
  66
  67     /** frame will be created if not found
  68      */
  69     const long CREATE = 8;
  70
  71         /** includes the direct siblings of the start frame
  72
  73             <p>
  74             Normally it's interpreted as search on the direct children of the parent
  75             only. But in combination with e.g. the CHILDREN flag it can include all
  76             children of it too.
  77             </p>
  78      */
  79     const long SIBLINGS = 16;
  80
  81         /** allow the search outside the current sub task tree of the whole possible frame tree
  82
  83         <p>
  84         If this flag isn't present, any search from bottom to top has to stop, if a top frame
  85         will be reached. It doesn't influence a search from top to bottom.
  86         But it can be used at the root of the frame tree to search on direct children of it only.
  87         Because the direct children of the root node are the root's of the task sub trees, which
  88         are top frames too. Instead of using the CHILDREN flag there, it's possible so to suppress
  89         a deeper search so.
  90         </p>
  91      */
  92     const long TASKS = 32;
  93
  94         /** includes all frames except frames in other tasks sub trees
  95         but doesn't create any new frame
  96      */
  97     const long ALL = 23;
  98
  99     /** searches in the whole hierarchy of frames
 100         but doesn't create any new frame
 101      */
 102     const long GLOBAL = 55;
 103 };
 104
 105
 106 }; }; }; };
 107
 108 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */