162 lines
5.9 KiB
C++
162 lines
5.9 KiB
C++
/*************************************************************************
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: targethelper.hxx,v $
|
|
*
|
|
* $Revision: 1.4 $
|
|
*
|
|
* last change: $Author: hr $ $Date: 2006-06-19 11:22:27 $
|
|
*
|
|
* The Contents of this file are made available subject to
|
|
* the terms of GNU Lesser General Public License Version 2.1.
|
|
*
|
|
*
|
|
* GNU Lesser General Public License Version 2.1
|
|
* =============================================
|
|
* Copyright 2005 by Sun Microsystems, Inc.
|
|
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License version 2.1, as published by the Free Software Foundation.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
|
* MA 02111-1307 USA
|
|
*
|
|
************************************************************************/
|
|
|
|
#ifndef __FRAMEWORK_TARGETHELPER_HXX_
|
|
#define __FRAMEWORK_TARGETHELPER_HXX_
|
|
|
|
//_______________________________________________
|
|
// own includes
|
|
|
|
#include <sal/types.h>
|
|
#include <rtl/ustring.hxx>
|
|
#include <targets.h>
|
|
//_______________________________________________
|
|
// namespace
|
|
|
|
namespace framework{
|
|
|
|
|
|
//_______________________________________________
|
|
// const
|
|
/* see definitions in targets.h
|
|
#define SPECIALTARGET_SELF ::rtl::OUString::createFromAscii("_self" )
|
|
#define SPECIALTARGET_PARENT ::rtl::OUString::createFromAscii("_parent" )
|
|
#define SPECIALTARGET_TOP ::rtl::OUString::createFromAscii("_top" )
|
|
#define SPECIALTARGET_BLANK ::rtl::OUString::createFromAscii("_blank" )
|
|
#define SPECIALTARGET_DEFAULT ::rtl::OUString::createFromAscii("_default" )
|
|
#define SPECIALTARGET_BEAMER ::rtl::OUString::createFromAscii("_beamer" )
|
|
#define SPECIALTARGET_MENUBAR ::rtl::OUString::createFromAscii("_menubar" )
|
|
#define SPECIALTARGET_HELPAGENT ::rtl::OUString::createFromAscii("_helpagent" )
|
|
#define SPECIALTARGET_HELPTASK ::rtl::OUString::createFromAscii("OFFICE_HELP_TASK")
|
|
*/
|
|
//_______________________________________________
|
|
// definitions
|
|
|
|
/** @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()).
|
|
|
|
@author as96863
|
|
*/
|
|
class TargetHelper
|
|
{
|
|
//___________________________________________
|
|
// const
|
|
|
|
public:
|
|
|
|
/** @short its used at the following interfaces to classify
|
|
target names.
|
|
*/
|
|
enum ESpecialTarget
|
|
{
|
|
E_NOT_SPECIAL ,
|
|
E_SELF ,
|
|
E_PARENT ,
|
|
E_TOP ,
|
|
E_BLANK ,
|
|
E_DEFAULT ,
|
|
E_BEAMER ,
|
|
E_MENUBAR ,
|
|
E_HELPAGENT ,
|
|
E_HELPTASK
|
|
};
|
|
|
|
//___________________________________________
|
|
// interface
|
|
|
|
public:
|
|
|
|
//___________________________________________
|
|
|
|
/** @short it checks, if the given target name is a well known special
|
|
one anyway and return a suitable enum value.
|
|
|
|
@note An empty target is similar to "_self"!
|
|
|
|
@param sTarget
|
|
the unknown target name, which should be checked.
|
|
|
|
@return Returns a suitable enum value, which classify the
|
|
given target name.
|
|
*/
|
|
static ESpecialTarget classifyTarget(const ::rtl::OUString& sTarget);
|
|
|
|
//___________________________________________
|
|
|
|
/** @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 unknwon 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/> otherwhise.
|
|
*/
|
|
static sal_Bool matchSpecialTarget(const ::rtl::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) its not a good idea to allow anything here :-)
|
|
|
|
Of course we can't check unknwon 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 sould be checked.
|
|
*/
|
|
static sal_Bool isValidNameForFrame(const ::rtl::OUString& sName);
|
|
};
|
|
|
|
} // namespace framework
|
|
|
|
#endif // #ifndef __FRAMEWORK_TARGETHELPER_HXX_
|