1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_frame_FrameSearchFlag_idl__
24#define __com_sun_star_frame_FrameSearchFlag_idl__
25
26
27//=============================================================================
28
29 module com {  module sun {  module star {  module frame {
30
31//=============================================================================
32/** these types describe the algorithm to be used to search a frame
33
34    <p>
35    Such flags will be used on methods <member>XFrame::findFrame()</member>,
36    <member>XDispatchProvider::queryDispatch()</member> or
37    <member>XComponentLoader::loadComponentFromURL()</member> if no special target
38    frame name (e.g. "_blank", "_self") is used.
39    </p>
40
41    @see XFrame::findFrame()
42    @see XDispatchProvider::queryDispatch()
43    @see XComponentLoader::loadComponentFromURL()
44 */
45published constants FrameSearchFlag
46{
47	//-------------------------------------------------------------------------
48    /** no longer supported
49
50        <p>
51        Using of this flag will do nothing. Use right combination of other flags
52        instead of this one.
53        </p>
54
55        @deprecated
56	 */
57	const long AUTO = 0;
58
59	//-------------------------------------------------------------------------
60    /** allows search on the parent frames
61	 */
62	const long PARENT = 1;
63
64	//-------------------------------------------------------------------------
65    /** includes the start frame himself
66	 */
67	const long SELF = 2;
68
69	//-------------------------------------------------------------------------
70        /** includes all child frames of the start frame
71
72            <p>
73            Note: That means all direct children and of course her childrens too.
74                  Search doesn't stop at the next level inside the tree!
75            </p>
76         */
77	const long CHILDREN = 4;
78
79	//-------------------------------------------------------------------------
80	/** frame will be created if not found
81	 */
82	const long CREATE = 8;
83
84	//-------------------------------------------------------------------------
85        /** includes the direct siblings of the start frame
86
87            <p>
88            Normaly it's interpreted as search on the direct childs of the parent
89            only. But in combination with e.g. the CHILDREN flag it can include all
90            children of it too.
91            </p>
92	 */
93	const long SIBLINGS = 16;
94
95	//-------------------------------------------------------------------------
96        /** allow the search outside the current sub task tree of the whole possible frame tree
97
98        <p>
99        If this flag isn't present, any search from bottom to top has to stop, if a top frame
100        will be reached. It doesn't influence a search from top to bottom.
101        But it can be used at the root of the frame tree to search on direct childrens of it only.
102        Because the direct children of the root node are the root's of the task sub trees, which
103        are top frames too. Instead of using the CHILDREN flag there, it's possible so to supress
104        a deeper search so.
105        </p>
106	 */
107	const long TASKS = 32;
108
109	//-------------------------------------------------------------------------
110        /** includes all frames except frames in other tasks sub trees
111        but doesn't create any new frame
112	 */
113	const long ALL = 23;
114
115	//-------------------------------------------------------------------------
116    /** searches in the whole hierarchy of frames
117        but doesn't create any new frame
118	 */
119	const long GLOBAL = 55;
120};
121
122//=============================================================================
123
124}; }; }; };
125
126#endif
127