framework/inc/properties.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <com/sun/star/uno/Any.hxx>
  23
  24 namespace framework{
  25
  26 /** properties for "Frame" class */
  27
  28 #define FRAME_PROPNAME_ASCII_DISPATCHRECORDERSUPPLIER   "DispatchRecorderSupplier"
  29 #define FRAME_PROPNAME_ASCII_ISHIDDEN                   "IsHidden"
  30 #define FRAME_PROPNAME_ASCII_LAYOUTMANAGER              "LayoutManager"
  31 #define FRAME_PROPNAME_ASCII_TITLE                      "Title"
  32 #define FRAME_PROPNAME_ASCII_INDICATORINTERCEPTION      "IndicatorInterception"
  33 #define FRAME_PROPNAME_ASCII_URL "URL"
  34
  35 // Please add new entries alphabetical sorted and correct all other handles!
  36 // Start counting with 0, so it can be used as direct index into an array too.
  37 // Don't forget updating of define FRAME_PROPCOUNT below!!!
  38 #define FRAME_PROPHANDLE_DISPATCHRECORDERSUPPLIER       0
  39 #define FRAME_PROPHANDLE_ISHIDDEN                       1
  40 #define FRAME_PROPHANDLE_LAYOUTMANAGER                  2
  41 #define FRAME_PROPHANDLE_TITLE                          3
  42 #define FRAME_PROPHANDLE_INDICATORINTERCEPTION          4
  43 #define FRAME_PROPHANDLE_URL 5
  44
  45 #define FRAME_PROPCOUNT 6
  46
  47 /** properties for "PathSettings" class */
  48
  49 #define PATHSETTINGS_PROPNAME_ASCII_ADDIN               "Addin"
  50 #define PATHSETTINGS_PROPNAME_ASCII_AUTOCORRECT         "AutoCorrect"
  51 #define PATHSETTINGS_PROPNAME_ASCII_AUTOTEXT            "AutoText"
  52 #define PATHSETTINGS_PROPNAME_ASCII_BACKUP              "Backup"
  53 #define PATHSETTINGS_PROPNAME_ASCII_BASIC               "Basic"
  54 #define PATHSETTINGS_PROPNAME_ASCII_BITMAP              "Bitmap"
  55 #define PATHSETTINGS_PROPNAME_ASCII_CONFIG              "Config"
  56 #define PATHSETTINGS_PROPNAME_ASCII_DICTIONARY          "Dictionary"
  57 #define PATHSETTINGS_PROPNAME_ASCII_FAVORITE            "Favorite"
  58 #define PATHSETTINGS_PROPNAME_ASCII_FILTER              "Filter"
  59 #define PATHSETTINGS_PROPNAME_ASCII_GALLERY             "Gallery"
  60 #define PATHSETTINGS_PROPNAME_ASCII_GRAPHIC             "Graphic"
  61 #define PATHSETTINGS_PROPNAME_ASCII_HELP                "Help"
  62 #define PATHSETTINGS_PROPNAME_ASCII_LINGUISTIC          "Linguistic"
  63 #define PATHSETTINGS_PROPNAME_ASCII_MODULE              "Module"
  64 #define PATHSETTINGS_PROPNAME_ASCII_PALETTE             "Palette"
  65 #define PATHSETTINGS_PROPNAME_ASCII_PLUGIN              "Plugin"
  66 #define PATHSETTINGS_PROPNAME_ASCII_STORAGE             "Storage"
  67 #define PATHSETTINGS_PROPNAME_ASCII_TEMP                "Temp"
  68 #define PATHSETTINGS_PROPNAME_ASCII_TEMPLATE            "Template"
  69 #define PATHSETTINGS_PROPNAME_ASCII_UICONFIG            "UIConfig"
  70 #define PATHSETTINGS_PROPNAME_ASCII_USERCONFIG          "UserConfig"
  71 #define PATHSETTINGS_PROPNAME_ASCII_USERDICTIONARY      "UserDictionary"
  72 #define PATHSETTINGS_PROPNAME_ASCII_WORK                "Work"
  73
  74
  75 /** properties for "LayoutManager" class */
  76
  77 #define LAYOUTMANAGER_PROPNAME_ASCII_MENUBARCLOSER          "MenuBarCloser"
  78 #define LAYOUTMANAGER_PROPNAME_ASCII_AUTOMATICTOOLBARS      "AutomaticToolbars"
  79 #define LAYOUTMANAGER_PROPNAME_ASCII_REFRESHVISIBILITY      "RefreshContextToolbarVisibility"
  80 #define LAYOUTMANAGER_PROPNAME_ASCII_HIDECURRENTUI          "HideCurrentUI"
  81 #define LAYOUTMANAGER_PROPNAME_ASCII_LOCKCOUNT              "LockCount"
  82 #define LAYOUTMANAGER_PROPNAME_ASCII_PRESERVE_CONTENT_SIZE  "PreserveContentSize"
  83
  84 #define LAYOUTMANAGER_PROPNAME_MENUBARCLOSER            LAYOUTMANAGER_PROPNAME_ASCII_MENUBARCLOSER
  85
  86 #define LAYOUTMANAGER_PROPHANDLE_MENUBARCLOSER          0
  87 #define LAYOUTMANAGER_PROPHANDLE_AUTOMATICTOOLBARS      1
  88 #define LAYOUTMANAGER_PROPHANDLE_REFRESHVISIBILITY      2
  89 #define LAYOUTMANAGER_PROPHANDLE_HIDECURRENTUI          3
  90 #define LAYOUTMANAGER_PROPHANDLE_LOCKCOUNT              4
  91 #define LAYOUTMANAGER_PROPHANDLE_PRESERVE_CONTENT_SIZE  5
  92
  93 /** properties for "UICommandDescription" class */
  94 #define UICOMMANDDESCRIPTION_NAMEACCESS_COMMANDIMAGELIST        "private:resource/image/commandimagelist"
  95 #define UICOMMANDDESCRIPTION_NAMEACCESS_COMMANDROTATEIMAGELIST  "private:resource/image/commandrotateimagelist"
  96 #define UICOMMANDDESCRIPTION_NAMEACCESS_COMMANDMIRRORIMAGELIST  "private:resource/image/commandmirrorimagelist"
  97
  98
  99 #define UICOMMANDDESCRIPTION_PROPERTIES_TOGGLEBUTTON            8
 100
 101 /** properties for "AutoRecovery" class */
 102
 103 #define AUTORECOVERY_PROPNAME_ASCII_EXISTS_RECOVERYDATA "ExistsRecoveryData"
 104 #define AUTORECOVERY_PROPNAME_ASCII_EXISTS_SESSIONDATA  "ExistsSessionData"
 105 #define AUTORECOVERY_PROPNAME_ASCII_CRASHED             "Crashed"
 106
 107 #define AUTORECOVERY_PROPNAME_EXISTS_RECOVERYDATA       AUTORECOVERY_PROPNAME_ASCII_EXISTS_RECOVERYDATA
 108 #define AUTORECOVERY_PROPNAME_EXISTS_SESSIONDATA        AUTORECOVERY_PROPNAME_ASCII_EXISTS_SESSIONDATA
 109 #define AUTORECOVERY_PROPNAME_CRASHED                   AUTORECOVERY_PROPNAME_ASCII_CRASHED
 110
 111 #define AUTORECOVERY_PROPHANDLE_EXISTS_RECOVERYDATA     0
 112 #define AUTORECOVERY_PROPHANDLE_EXISTS_SESSIONDATA      1
 113 #define AUTORECOVERY_PROPHANDLE_CRASHED                 2
 114
 115 #define AUTORECOVERY_PROPCOUNT                          3
 116
 117 /** properties for Filter config */
 118
 119 #define FILTER_PROPNAME_ASCII_DOCUMENTSERVICE           "DocumentService"
 120
 121 /** properties for office module config (Setup.xcu) */
 122
 123 #define OFFICEFACTORY_PROPNAME_ASCII_UINAME             "ooSetupFactoryUIName"
 124 #define OFFICEFACTORY_PROPNAME_ASCII_ICON               "ooSetupFactoryIcon"
 125
 126 /** properties for tab window (old) */
 127 #define TABWINDOW_PROPNAME_ASCII_PARENTWINDOW           "ParentWindow"
 128 #define TABWINDOW_PROPNAME_ASCII_TOPWINDOW              "TopWindow"
 129 #define TABWINDOW_PROPNAME_PARENTWINDOW                 TABWINDOW_PROPNAME_ASCII_PARENTWINDOW
 130 #define TABWINDOW_PROPNAME_TOPWINDOW                    TABWINDOW_PROPNAME_ASCII_TOPWINDOW
 131
 132 #define TABWINDOW_PROPHANDLE_PARENTWINDOW               0
 133 #define TABWINDOW_PROPHANDLE_TOPWINDOW                  1
 134 #define TABWINDOW_PROPCOUNT                             2
 135
 136 #define TABWINDOWSERVICE_PROPHANDLE_WINDOW              0
 137
 138 /** provides some helper methods to implement property sets. */
 139
 140 class PropHelper
 141 {
 142     public:
 143
 144     /** checks if given property will be changed by this settings.
 145      *  We compare the content of the given any values. If they are different we return sal_True - sal_False otherwise.
 146      *
 147      *  @param  aCurrentValue   contains the current value for this property
 148      *  @param  aNewValue       contains the new value for this property
 149      *  @param  aOldValue       returns the current value, in case something will be changed
 150      *  @param  aChangedValue   returns the new value, in case something will be changed
 151      *
 152      *  @return <True/> if value of this property will be changed; <False/> otherwise.
 153      */
 154
 155     static bool willPropertyBeChanged( const css::uno::Any& aCurrentValue ,
 156                                            const css::uno::Any& aNewValue     ,
 157                                                  css::uno::Any& aOldValue     ,
 158                                                  css::uno::Any& aChangedValue )
 159     {
 160         bool bChanged = false;
 161
 162         // clear return parameter to be sure, to put out only valid values ...
 163         aOldValue.clear();
 164         aChangedValue.clear();
 165
 166         // if value change ...
 167         bChanged = aCurrentValue != aNewValue;
 168         if (bChanged)
 169         {
 170             // ... set information of change.
 171             aOldValue     = aCurrentValue;
 172             aChangedValue = aNewValue;
 173         }
 174
 175         return bChanged;
 176     }
 177 };
 178
 179 } // namespace framework
 180
 181 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */