Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 93 insertions, 0 deletions

diff --git a/framework/source/inc/loadenv/targethelper.hxx b/framework/source/inc/loadenv/targethelper.hxx
new file mode 100644
index 000000000..046cdfeb1
--- /dev/null
+++ b/framework/source/inc/loadenv/targethelper.hxx
@@ -0,0 +1,93 @@
+/* -*- 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 INCLUDED_FRAMEWORK_SOURCE_INC_LOADENV_TARGETHELPER_HXX
+#define INCLUDED_FRAMEWORK_SOURCE_INC_LOADENV_TARGETHELPER_HXX
+
+#include <rtl/ustring.hxx>
+
+namespace framework{
+
+/** @short  can be used to detect, if a target name (used e.g. for XFrame.findFrame())
+            has a special meaning or can be used as normal frame name (e.g. for XFrame.setName()).
+ */
+class TargetHelper
+{
+
+    public:
+
+        /** @short  it's used at the following interfaces to classify
+                    target names.
+         */
+        enum class ESpecialTarget
+        {
+            Blank,
+            Default,
+            Beamer,
+            HelpTask
+        };
+
+    // interface
+
+    public:
+
+        /** @short  it checks the given unknown target name,
+                    if it's the expected special one.
+
+            @note   An empty target is similar to "_self"!
+
+            @param  sCheckTarget
+                    must be the unknown target name, which should be checked.
+
+            @param  eSpecialTarget
+                    represent the expected target.
+
+            @return It returns <TRUE/> if <var>sCheckTarget</var> represent
+                    the expected <var>eSpecialTarget</var> value; <FALSE/> otherwise.
+         */
+        static bool matchSpecialTarget(const OUString& sCheckTarget  ,
+                                                 ESpecialTarget   eSpecialTarget);
+
+        /** @short  it checks, if the given name can be used
+                    to set it at a frame using XFrame.setName() method.
+
+            @descr  Because we handle special targets in a hard coded way
+                    (means we do not check the real name of a frame then)
+                    such named frames will never be found!
+
+                    And in case such special names can exists one times only
+                    by definition inside the same frame tree (e.g. _beamer and
+                    OFFICE_HELP_TASK) it's not a good idea to allow anything here :-)
+
+                    Of course we can't check unknown names, which are not special ones.
+                    But we decide, that it's not allowed to use "_" as first sign
+                    (because we reserve this letter for our own purposes!)
+                    and the value must not a well known special target.
+
+            @param  sName
+                    the new frame name, which should be checked.
+         */
+        static bool isValidNameForFrame(const OUString& sName);
+};
+
+} // namespace framework
+
+#endif // INCLUDED_FRAMEWORK_SOURCE_INC_LOADENV_TARGETHELPER_HXX
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */