/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: properties.h,v $
* $Revision: 1.16 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __FRAMEWORK_PROPERTIES_H_
#define __FRAMEWORK_PROPERTIES_H_
//_______________________________________________
// includes
#include <macros/generic.hxx>
#include <general.h>
//_______________________________________________
// namespace
namespace framework{
//_______________________________________________
/** properties for "StatusIndicatorFactory" class */
#define STATUSINDICATORFACTORY_PROPNAME_ASCII_FRAME "Frame"
#define STATUSINDICATORFACTORY_PROPNAME_ASCII_WINDOW "Window"
#define STATUSINDICATORFACTORY_PROPNAME_ASCII_ALLOWPARENTSHOW "AllowParentShow"
#define STATUSINDICATORFACTORY_PROPNAME_ASCII_DISABLERESCHEDULE "DisableReschedule"
#define STATUSINDICATORFACTORY_PROPNAME_FRAME DECLARE_ASCII(STATUSINDICATORFACTORY_PROPNAME_ASCII_FRAME )
#define STATUSINDICATORFACTORY_PROPNAME_WINDOW DECLARE_ASCII(STATUSINDICATORFACTORY_PROPNAME_ASCII_WINDOW )
#define STATUSINDICATORFACTORY_PROPNAME_ALLOWPARENTSHOW DECLARE_ASCII(STATUSINDICATORFACTORY_PROPNAME_ASCII_ALLOWPARENTSHOW )
#define STATUSINDICATORFACTORY_PROPNAME_DISABLERESCHEDULE DECLARE_ASCII(STATUSINDICATORFACTORY_PROPNAME_ASCII_DISABLERESCHEDULE)
//_______________________________________________
/** properties for "Frame" class */
#define FRAME_PROPNAME_ASCII_DISPATCHRECORDERSUPPLIER "DispatchRecorderSupplier"
#define FRAME_PROPNAME_ASCII_ISHIDDEN "IsHidden"
#define FRAME_PROPNAME_ASCII_LAYOUTMANAGER "LayoutManager"
#define FRAME_PROPNAME_ASCII_TITLE "Title"
#define FRAME_PROPNAME_ASCII_INDICATORINTERCEPTION "IndicatorInterception"
#define FRAME_PROPNAME_DISPATCHRECORDERSUPPLIER DECLARE_ASCII(FRAME_PROPNAME_ASCII_DISPATCHRECORDERSUPPLIER)
#define FRAME_PROPNAME_ISHIDDEN DECLARE_ASCII(FRAME_PROPNAME_ASCII_ISHIDDEN )
#define FRAME_PROPNAME_LAYOUTMANAGER DECLARE_ASCII(FRAME_PROPNAME_ASCII_LAYOUTMANAGER )
#define FRAME_PROPNAME_TITLE DECLARE_ASCII(FRAME_PROPNAME_ASCII_TITLE )
#define FRAME_PROPNAME_INDICATORINTERCEPTION DECLARE_ASCII(FRAME_PROPNAME_ASCII_INDICATORINTERCEPTION )
// Please add new entries alphabetical sorted and correct all other handles!
// Start counting with 0, so it can be used as direct index into an array too.
// Don't forget updating of define FRAME_PROPCOUNT below!!!
#define FRAME_PROPHANDLE_DISPATCHRECORDERSUPPLIER 0
#define FRAME_PROPHANDLE_ISHIDDEN 1
#define FRAME_PROPHANDLE_LAYOUTMANAGER 2
#define FRAME_PROPHANDLE_TITLE 3
#define FRAME_PROPHANDLE_INDICATORINTERCEPTION 4
#define FRAME_PROPCOUNT 5
//_______________________________________________
/** properties for "Desktop" class */
#define DESKTOP_PROPNAME_ASCII_ACTIVEFRAME "ActiveFrame"
#define DESKTOP_PROPNAME_ASCII_DISPATCHRECORDERSUPPLIER "DispatchRecorderSupplier"
#define DESKTOP_PROPNAME_ASCII_ISPLUGGED "IsPlugged"
#define DESKTOP_PROPNAME_ASCII_SUSPENDQUICKSTARTVETO "SuspendQuickstartVeto"
#define DESKTOP_PROPNAME_ASCII_TITLE "Title"
#define DESKTOP_PROPNAME_ACTIVEFRAME DECLARE_ASCII(DESKTOP_PROPNAME_ASCII_ACTIVEFRAME )
#define DESKTOP_PROPNAME_DISPATCHRECORDERSUPPLIER DECLARE_ASCII(DESKTOP_PROPNAME_ASCII_DISPATCHRECORDERSUPPLIER)
#define DESKTOP_PROPNAME_ISPLUGGED DECLARE_ASCII(DESKTOP_PROPNAME_ASCII_ISPLUGGED )
#define DESKTOP_PROPNAME_SUSPENDQUICKSTARTVETO DECLARE_ASCII(DESKTOP_PROPNAME_ASCII_SUSPENDQUICKSTARTVETO )
#define DESKTOP_PROPNAME_TITLE DECLARE_ASCII(DESKTOP_PROPNAME_ASCII_TITLE )
// Please add new entries alphabetical sorted and correct all other handles!
// Start counting with 0, so it can be used as direct index into an array too.
// Don't forget updating of define DESKTOP_PROPCOUNT below!!!
#define DESKTOP_PROPHANDLE_ACTIVEFRAME 0
#define DESKTOP_PROPHANDLE_DISPATCHRECORDERSUPPLIER 1
#define DESKTOP_PROPHANDLE_ISPLUGGED 2
#define DESKTOP_PROPHANDLE_SUSPENDQUICKSTARTVETO 3
#define DESKTOP_PROPHANDLE_TITLE 4
#define DESKTOP_PROPCOUNT 5
//_______________________________________________
/** properties for "PathSettings" class */
#define PATHSETTINGS_PROPNAME_ASCII_ADDIN "Addin"
#define PATHSETTINGS_PROPNAME_ASCII_AUTOCORRECT "AutoCorrect"
#define PATHSETTINGS_PROPNAME_ASCII_AUTOTEXT "AutoText"
#define PATHSETTINGS_PROPNAME_ASCII_BACKUP "Backup"
#define PATHSETTINGS_PROPNAME_ASCII_BASIC "Basic"
#define PATHSETTINGS_PROPNAME_ASCII_BITMAP "Bitmap"
#define PATHSETTINGS_PROPNAME_ASCII_CONFIG "Config"
#define PATHSETTINGS_PROPNAME_ASCII_DICTIONARY "Dictionary"
#define PATHSETTINGS_PROPNAME_ASCII_FAVORITE "Favorite"
#define PATHSETTINGS_PROPNAME_ASCII_FILTER "Filter"
#define PATHSETTINGS_PROPNAME_ASCII_GALLERY "Gallery"
#define PATHSETTINGS_PROPNAME_ASCII_GRAPHIC "Graphic"
#define PATHSETTINGS_PROPNAME_ASCII_HELP "Help"
#define PATHSETTINGS_PROPNAME_ASCII_LINGUISTIC "Linguistic"
#define PATHSETTINGS_PROPNAME_ASCII_MODULE "Module"
#define PATHSETTINGS_PROPNAME_ASCII_PALETTE "Palette"
#define PATHSETTINGS_PROPNAME_ASCII_PLUGIN "Plugin"
#define PATHSETTINGS_PROPNAME_ASCII_STORAGE "Storage"
#define PATHSETTINGS_PROPNAME_ASCII_TEMP "Temp"
#define PATHSETTINGS_PROPNAME_ASCII_TEMPLATE "Template"
#define PATHSETTINGS_PROPNAME_ASCII_UICONFIG "UIConfig"
#define PATHSETTINGS_PROPNAME_ASCII_USERCONFIG "UserConfig"
#define PATHSETTINGS_PROPNAME_ASCII_USERDICTIONARY "UserDictionary"
#define PATHSETTINGS_PROPNAME_ASCII_WORK "Work"
#define PATHSETTINGS_PROPNAME_ADDIN ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_ADDIN )
#define PATHSETTINGS_PROPNAME_AUTOCORRECT ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_AUTOCORRECT )
#define PATHSETTINGS_PROPNAME_AUTOTEXT ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_AUTOTEXT )
#define PATHSETTINGS_PROPNAME_BACKUP ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_BACKUP )
#define PATHSETTINGS_PROPNAME_BASIC ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_BASIC )
#define PATHSETTINGS_PROPNAME_BITMAP ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_BITMAP )
#define PATHSETTINGS_PROPNAME_CONFIG ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_CONFIG )
#define PATHSETTINGS_PROPNAME_DICTIONARY ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_DICTIONARY )
#define PATHSETTINGS_PROPNAME_FAVORITE ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_FAVORITE )
#define PATHSETTINGS_PROPNAME_FILTER ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_FILTER )
#define PATHSETTINGS_PROPNAME_GALLERY ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_GALLERY )
#define PATHSETTINGS_PROPNAME_GRAPHIC ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_GRAPHIC )
#define PATHSETTINGS_PROPNAME_HELP ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_HELP )
#define PATHSETTINGS_PROPNAME_LINGUISTIC ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_LINGUISTIC )
#define PATHSETTINGS_PROPNAME_MODULE ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_MODULE )
#define PATHSETTINGS_PROPNAME_PALETTE ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_PALETTE )
#define PATHSETTINGS_PROPNAME_PLUGIN ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_PLUGIN )
#define PATHSETTINGS_PROPNAME_STORAGE ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_STORAGE )
#define PATHSETTINGS_PROPNAME_TEMP ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_TEMP )
#define PATHSETTINGS_PROPNAME_TEMPLATE ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_TEMPLATE )
#define PATHSETTINGS_PROPNAME_UICONFIG ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_UICONFIG )
#define PATHSETTINGS_PROPNAME_USERCONFIG ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_USERCONFIG )
#define PATHSETTINGS_PROPNAME_USERDICTIONARY ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_USERDICTIONARY)
#define PATHSETTINGS_PROPNAME_WORK ::rtl::OUString::createFromAscii(PATHSETTINGS_PROPNAME_ASCII_WORK )
// Please add new entries alphabetical sorted and correct all other handles!
// Start counting with 0, so it can be used as direct index into an array too.
// Don't forget updating of define PATHSETTINGS_PROPCOUNT below!!!
#define PATHSETTINGS_PROPHANDLE_ADDIN 0
#define PATHSETTINGS_PROPHANDLE_AUTOCORRECT 1
#define PATHSETTINGS_PROPHANDLE_AUTOTEXT 2
#define PATHSETTINGS_PROPHANDLE_BACKUP 3
#define PATHSETTINGS_PROPHANDLE_BASIC 4
#define PATHSETTINGS_PROPHANDLE_BITMAP 5
#define PATHSETTINGS_PROPHANDLE_CONFIG 6
#define PATHSETTINGS_PROPHANDLE_DICTIONARY 7
#define PATHSETTINGS_PROPHANDLE_FAVORITE 8
#define PATHSETTINGS_PROPHANDLE_FILTER 9
#define PATHSETTINGS_PROPHANDLE_GALLERY 10
#define PATHSETTINGS_PROPHANDLE_GRAPHIC 11
#define PATHSETTINGS_PROPHANDLE_HELP 12
#define PATHSETTINGS_PROPHANDLE_LINGUISTIC 13
#define PATHSETTINGS_PROPHANDLE_MODULE 14
#define PATHSETTINGS_PROPHANDLE_PALETTE 15
#define PATHSETTINGS_PROPHANDLE_PLUGIN 16
#define PATHSETTINGS_PROPHANDLE_STORAGE 17
#define PATHSETTINGS_PROPHANDLE_TEMP 18
#define PATHSETTINGS_PROPHANDLE_TEMPLATE 19
#define PATHSETTINGS_PROPHANDLE_UICONFIG 20
#define PATHSETTINGS_PROPHANDLE_USERCONFIG 21
#define PATHSETTINGS_PROPHANDLE_USERDICTIONARY 22
#define PATHSETTINGS_PROPHANDLE_WORK 23
#define PATHSETTINGS_PROPCOUNT 24
//_______________________________________________
/** properties for "LayoutManager" class */
#define LAYOUTMANAGER_PROPNAME_ASCII_MENUBARCLOSER "MenuBarCloser"
#define LAYOUTMANAGER_PROPNAME_ASCII_AUTOMATICTOOLBARS "AutomaticToolbars"
#define LAYOUTMANAGER_PROPNAME_ASCII_REFRESHVISIBILITY "RefreshContextToolbarVisibility"
#define LAYOUTMANAGER_PROPNAME_ASCII_HIDECURRENTUI "HideCurrentUI"
#define LAYOUTMANAGER_PROPNAME_ASCII_LOCKCOUNT "LockCount"
#define LAYOUTMANAGER_PROPNAME_ASCII_PRESERVE_CONTENT_SIZE "PreserveContentSize"
#define LAYOUTMANAGER_PROPNAME_MENUBARCLOSER ::rtl::OUString::createFromAscii( LAYOUTMANAGER_PROPNAME_ASCII_MENUBARCLOSER )
#define LAYOUTMANAGER_PROPNAME_AUTOMATICTOOLBARS ::rtl::OUString::createFromAscii( LAYOUTMANAGER_PROPNAME_ASCII_AUTOMATICTOOLBARS )
#define LAYOUTMANAGER_PROPNAME_REFRESHVISIBILITY ::rtl::OUString::createFromAscii( LAYOUTMANAGER_PROPNAME_ASCII_REFRESHVISIBILITY )
#define LAYOUTMANAGER_PROPNAME_HIDECURRENTUI ::rtl::OUString::createFromAscii( LAYOUTMANAGER_PROPNAME_ASCII_HIDECURRENTUI )
#define LAYOUTMANAGER_PROPNAME_LOCKCOUNT ::rtl::OUString::createFromAscii( LAYOUTMANAGER_PROPNAME_ASCII_LOCKCOUNT )
#define LAYOUTMANAGER_PROPNAME_PRESERVE_CONTENT_SIZE ::rtl::OUString::createFromAscii( LAYOUTMANAGER_PROPNAME_ASCII_PRESERVE_CONTENT_SIZE )
#define LAYOUTMANAGER_PROPHANDLE_MENUBARCLOSER 0
#define LAYOUTMANAGER_PROPHANDLE_AUTOMATICTOOLBARS 1
#define LAYOUTMANAGER_PROPHANDLE_REFRESHVISIBILITY 2
#define LAYOUTMANAGER_PROPHANDLE_HIDECURRENTUI 3
#define LAYOUTMANAGER_PROPHANDLE_LOCKCOUNT 4
#define LAYOUTMANAGER_PROPHANDLE_PRESERVE_CONTENT_SIZE 5
//_______________________________________________
/** properties for "UICommandDescription" class */
#define UICOMMANDDESCRIPTION_NAMEACCESS_COMMANDIMAGELIST "private:resource/image/commandimagelist"
#define UICOMMANDDESCRIPTION_NAMEACCESS_COMMANDROTATEIMAGELIST "private:resource/image/commandrotateimagelist"
#define UICOMMANDDESCRIPTION_NAMEACCESS_COMMANDMIRRORIMAGELIST "private:resource/image/commandmirrorimagelist"
//_______________________________________________
/** properties for "AutoRecovery" class */
#define AUTORECOVERY_PROPNAME_ASCII_EXISTS_RECOVERYDATA "ExistsRecoveryData"
#define AUTORECOVERY_PROPNAME_ASCII_EXISTS_SESSIONDATA "ExistsSessionData"
#define AUTORECOVERY_PROPNAME_ASCII_CRASHED "Crashed"
#define AUTORECOVERY_PROPNAME_EXISTS_RECOVERYDATA ::rtl::OUString::createFromAscii( AUTORECOVERY_PROPNAME_ASCII_EXISTS_RECOVERYDATA )
#define AUTORECOVERY_PROPNAME_EXISTS_SESSIONDATA ::rtl::OUString::createFromAscii( AUTORECOVERY_PROPNAME_ASCII_EXISTS_SESSIONDATA )
#define AUTORECOVERY_PROPNAME_CRASHED ::rtl::OUString::createFromAscii( AUTORECOVERY_PROPNAME_ASCII_CRASHED )
#define AUTORECOVERY_PROPHANDLE_EXISTS_RECOVERYDATA 0
#define AUTORECOVERY_PROPHANDLE_EXISTS_SESSIONDATA 1
#define AUTORECOVERY_PROPHANDLE_CRASHED 2
#define AUTORECOVERY_PROPCOUNT 3
//_______________________________________________
/** properties for Filter config */
#define FILTER_PROPNAME_ASCII_DOCUMENTSERVICE "DocumentService"
#define FILTER_PROPNAME_DOCUMENTSERVICE ::rtl::OUString::createFromAscii( FILTER_PROPNAME_ASCII_DOCUMENTSERVICE )
//_______________________________________________
/** properties for office module config (Setup.xcu) */
#define OFFICEFACTORY_PROPNAME_ASCII_WINDOWATTRIBUTES "ooSetupFactoryWindowAttributes"
#define OFFICEFACTORY_PROPNAME_ASCII_UINAME "ooSetupFactoryUIName"
#define OFFICEFACTORY_PROPNAME_ASCII_ICON "ooSetupFactoryIcon"
#define OFFICEFACTORY_PROPNAME_WINDOWATTRIBUTES ::rtl::OUString::createFromAscii( OFFICEFACTORY_PROPNAME_ASCII_WINDOWATTRIBUTES )
#define OFFICEFACTORY_PROPNAME_UINAME ::rtl::OUString::createFromAscii( OFFICEFACTORY_PROPNAME_ASCII_UINAME )
#define OFFICEFACTORY_PROPNAME_ICON ::rtl::OUString::createFromAscii( OFFICEFACTORY_PROPNAME_ASCII_ICON )
//_______________________________________________
/** properties for tab window (old) */
#define TABWINDOW_PROPNAME_ASCII_PARENTWINDOW "ParentWindow"
#define TABWINDOW_PROPNAME_ASCII_TOPWINDOW "TopWindow"
#define TABWINDOW_PROPNAME_PARENTWINDOW ::rtl::OUString::createFromAscii( TABWINDOW_PROPNAME_ASCII_PARENTWINDOW )
#define TABWINDOW_PROPNAME_TOPWINDOW ::rtl::OUString::createFromAscii( TABWINDOW_PROPNAME_ASCII_TOPWINDOW )
#define TABWINDOW_PROPHANDLE_PARENTWINDOW 0
#define TABWINDOW_PROPHANDLE_TOPWINDOW 1
#define TABWINDOW_PROPCOUNT 2
//_______________________________________________
/** properties for tab window service (new) */
#define TABWINDOWSERVICE_PROPNAME_ASCII_WINDOW "Window"
#define TABWINDOWSERVICE_PROPNAME_WINDOW ::rtl::OUString::createFromAscii( TABWINDOWSERVICE_PROPNAME_ASCII_WINDOW )
#define TABWINDOWSERVICE_PROPHANDLE_WINDOW 0
#define TABWINDOWSERVICE_PROPCOUNT 1
//_______________________________________________
/** properties of tabreg service */
static const char* TABREG_PROPNAME_ASCII_TITLE = "title";
static const ::rtl::OUString TABREG_PROPNAME_TITLE = ::rtl::OUString::createFromAscii(TABREG_PROPNAME_ASCII_TITLE);
//_______________________________________________
/** properties of controller service */
static const char* CONTROLLER_PROPNAME_ASCII_ICONID = "IconId";
static const ::rtl::OUString CONTROLLER_PROPNAME_ICONID = ::rtl::OUString::createFromAscii(CONTROLLER_PROPNAME_ASCII_ICONID);
//_______________________________________________
/** provides some helper methods to implement property sets. */
class PropHelper
{
public:
//___________________________________________
/** checks if given property will be changed by this settings.
* We compare the content of the given any values. If they are different we return TRUE - FALSE otherwhise.
*
* @param aCurrentValue contains the current value for this property
* @param aNewValue contains the new value for this property
* @param aOldValue returns the current value, in case somthing will be changed
* @param aChangedValue returns the new value, in case somthing will be changed
*
* @return <True/> if value of this property will be changed; <False/> otherwhise.
*/
static sal_Bool willPropertyBeChanged( const css::uno::Any& aCurrentValue ,
const css::uno::Any& aNewValue ,
css::uno::Any& aOldValue ,
css::uno::Any& aChangedValue )
{
sal_Bool bChanged = sal_False;
// clear return parameter to be shure, to put out only valid values ...
aOldValue.clear();
aChangedValue.clear();
// if value change ...
bChanged = !(aCurrentValue==aNewValue);
if (bChanged)
{
// ... set information of change.
aOldValue = aCurrentValue;
aChangedValue = aNewValue ;
}
return bChanged;
}
//___________________________________________
/** calculates the count of items inside the given ascii array.
*
* @param pArray must point to an array of items from type sal_Char
*
* @return The count of items inside this array, calculated by knowing the size of sal_Char.
*/
static sal_Int32 calculatePropArrayCount( const sal_Char* pArray[] )
{
return (sal_Int32)(sizeof(pArray)/sizeof(sal_Char*));
}
};
} // namespace framework
#endif // #ifndef __FRAMEWORK_PROPERTIES_H_