summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/frame/FrameSearchFlag.idl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
commited5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch)
tree7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/frame/FrameSearchFlag.idl
parentInitial commit. (diff)
downloadlibreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.tar.xz
libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.zip
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/frame/FrameSearchFlag.idl')
-rw-r--r--offapi/com/sun/star/frame/FrameSearchFlag.idl112
1 files changed, 112 insertions, 0 deletions
diff --git a/offapi/com/sun/star/frame/FrameSearchFlag.idl b/offapi/com/sun/star/frame/FrameSearchFlag.idl
new file mode 100644
index 000000000..ad0a5e188
--- /dev/null
+++ b/offapi/com/sun/star/frame/FrameSearchFlag.idl
@@ -0,0 +1,112 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * 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 .
+ */
+#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 XFrame::findFrame(),
+ XDispatchProvider::queryDispatch() or
+ XComponentLoader::loadComponentFromURL() 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 children 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>
+ Normally it's interpreted as search on the direct children 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 children 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
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */