| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef __com_sun_star_frame_FrameSearchFlag_idl__ |
| #define __com_sun_star_frame_FrameSearchFlag_idl__ |
| |
| |
| //============================================================================= |
| |
| module com { module sun { module star { module frame { |
| |
| //============================================================================= |
| /** these types describe the algorithm to be used to search a frame |
| |
| <p> |
| Such flags will be used on methods <member>XFrame::findFrame()</member>, |
| <member>XDispatchProvider::queryDispatch()</member> or |
| <member>XComponentLoader::loadComponentFromURL()</member> if no special target |
| frame name (e.g. "_blank", "_self") is used. |
| </p> |
| |
| @see XFrame::findFrame() |
| @see XDispatchProvider::queryDispatch() |
| @see XComponentLoader::loadComponentFromURL() |
| */ |
| published constants FrameSearchFlag |
| { |
| //------------------------------------------------------------------------- |
| /** no longer supported |
| |
| <p> |
| Using of this flag will do nothing. Use right combination of other flags |
| instead of this one. |
| </p> |
| |
| @deprecated |
| */ |
| const long AUTO = 0; |
| |
| //------------------------------------------------------------------------- |
| /** allows search on the parent frames |
| */ |
| const long PARENT = 1; |
| |
| //------------------------------------------------------------------------- |
| /** includes the start frame himself |
| */ |
| const long SELF = 2; |
| |
| //------------------------------------------------------------------------- |
| /** includes all child frames of the start frame |
| |
| <p> |
| Note: That means all direct children and of course her childrens too. |
| Search doesn't stop at the next level inside the tree! |
| </p> |
| */ |
| const long CHILDREN = 4; |
| |
| //------------------------------------------------------------------------- |
| /** frame will be created if not found |
| */ |
| const long CREATE = 8; |
| |
| //------------------------------------------------------------------------- |
| /** includes the direct siblings of the start frame |
| |
| <p> |
| Normaly it's interpreted as search on the direct childs of the parent |
| only. But in combination with e.g. the CHILDREN flag it can include all |
| children of it too. |
| </p> |
| */ |
| const long SIBLINGS = 16; |
| |
| //------------------------------------------------------------------------- |
| /** allow the search outside the current sub task tree of the whole possible frame tree |
| |
| <p> |
| If this flag isn't present, any search from bottom to top has to stop, if a top frame |
| will be reached. It doesn't influence a search from top to bottom. |
| But it can be used at the root of the frame tree to search on direct childrens of it only. |
| Because the direct children of the root node are the root's of the task sub trees, which |
| are top frames too. Instead of using the CHILDREN flag there, it's possible so to suppress |
| a deeper search so. |
| </p> |
| */ |
| const long TASKS = 32; |
| |
| //------------------------------------------------------------------------- |
| /** includes all frames except frames in other tasks sub trees |
| but doesn't create any new frame |
| */ |
| const long ALL = 23; |
| |
| //------------------------------------------------------------------------- |
| /** searches in the whole hierarchy of frames |
| but doesn't create any new frame |
| */ |
| const long GLOBAL = 55; |
| }; |
| |
| //============================================================================= |
| |
| }; }; }; }; |
| |
| #endif |