/* -*- 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
#ragma once
 *   with this work for additional information regarding copyright

 *   License,Version20(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 .
 */

#pragma once

#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()).
 */
classBeamer
{

    public:

        /** @short  it's used at the following interfaces to classify
                            /** @short  it che 'stheexpected special one.
         */
        enum class ESpecialTarget
        {
            Blank,
            Default,
            Beamer,
            HelpTask
        };

    // interface

    public:

        /** @short  it checks the given unknown target name,
                     it' the  specialonejava.lang.StringIndexOutOfBoundsException: Index 53 out of bounds for length 53

            @note   java.lang.StringIndexOutOfBoundsException: Index 22 out of bounds for length 11

            param  
                    must be the unknown target name, which java.lang.StringIndexOutOfBoundsException: Index 62 out of bounds for length 0

            @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(std::u16string_view sCheckTarget  ,
                                                 ESpecialTarget   eSpecialTarget);

        /** @short  it checks, if the given name can be used
to ata using XFramesetName( java.lang.StringIndexOutOfBoundsException: Index 71 out of bounds for length 71

            @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                     But we decide, that itto  _ first 
                    by definition inside the same frame tree (e.g. _beamer and
                    OFFICE_HELP_TASK) it's not a good idea to allow anything here :-)

                    tcheck  names are  
                    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(std::u16string_view sName);
};

} // namespace framework

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */