extensions/source/propctrlr/formmetadata.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: formmetadata.hxx,v $
  10  * $Revision: 1.35 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _EXTENSIONS_PROPCTRLR_FORMMETADATA_HXX_
  32 #define _EXTENSIONS_PROPCTRLR_FORMMETADATA_HXX_
  33
  34 #include "propertyinfo.hxx"
  35 #ifndef _EXTENSIONS_PROPCTRLR_MODULEPRC_HXX_
  36 #include "modulepcr.hxx"
  37 #endif
  38 #include "enumrepresentation.hxx"
  39 #include <comphelper/composedprops.hxx>
  40
  41 //............................................................................
  42 namespace pcr
  43 {
  44 //............................................................................
  45
  46     struct OPropertyInfoImpl;
  47
  48     //========================================================================
  49     //= OPropertyInfoService
  50     //========================================================================
  51     class OPropertyInfoService
  52                 :public IPropertyInfoService
  53                 ,public ::comphelper::IPropertySetComposerCallback
  54                 ,public PcrClient
  55     {
  56     protected:
  57         static sal_uInt16                               s_nCount;
  58         static OPropertyInfoImpl*               s_pPropertyInfos;
  59         // TODO: a real structure which allows quick access by name as well as by id
  60
  61     public:
  62         // IPropertyInfoService
  63         virtual sal_Int32                                           getPropertyId(const String& _rName) const;
  64         virtual String                                              getPropertyTranslation(sal_Int32 _nId) const;
  65         virtual sal_Int32                                           getPropertyHelpId(sal_Int32 _nId) const;
  66         virtual sal_Int16                                           getPropertyPos(sal_Int32 _nId) const;
  67         virtual sal_uInt32                          getPropertyUIFlags(sal_Int32 _nId) const;
  68         virtual ::std::vector< ::rtl::OUString >    getPropertyEnumRepresentations(sal_Int32 _nId) const;
  69         virtual String                              getPropertyName( sal_Int32 _nPropId );
  70
  71         // IPropertySetComposerCallback
  72         virtual sal_Bool                isComposeable( const ::rtl::OUString& _rPropertyName ) const;
  73
  74     protected:
  75         static const OPropertyInfoImpl* getPropertyInfo();
  76
  77         static const OPropertyInfoImpl* getPropertyInfo(const String& _rName);
  78         static const OPropertyInfoImpl* getPropertyInfo(sal_Int32 _nId);
  79     };
  80
  81     //========================================================================
  82     //= DefaultEnumRepresentation
  83     //========================================================================
  84     /** an implementation of the IPropertyEnumRepresentation
  85
  86         To be used with properties which, in formmetadata.cxx, are declared as ENUM.
  87     */
  88     class DefaultEnumRepresentation : public IPropertyEnumRepresentation
  89     {
  90     private:
  91         oslInterlockedCount         m_refCount;
  92         const IPropertyInfoService& m_rMetaData;
  93         ::com::sun::star::uno::Type m_aType;
  94         const sal_Int32             m_nPropertyId;
  95
  96     public:
  97         /** constructs an instance
  98
  99             @param _rInfo
 100                 An instance implementing IPropertyInfoService. Must live at least as
 101                 long as the DefaultEnumRepresentation should live.
 102         */
 103         DefaultEnumRepresentation( const IPropertyInfoService& _rInfo, const ::com::sun::star::uno::Type& _rType, sal_Int32 _nPropertyId );
 104
 105     protected:
 106         ~DefaultEnumRepresentation();
 107
 108     protected:
 109         // IPropertyEnumRepresentation implementqation
 110         virtual ::std::vector< ::rtl::OUString >
 111                                     SAL_CALL getDescriptions() const;
 112         virtual void                SAL_CALL getValueFromDescription( const ::rtl::OUString& _rDescription, ::com::sun::star::uno::Any& _out_rValue ) const;
 113         virtual ::rtl::OUString     SAL_CALL getDescriptionForValue( const ::com::sun::star::uno::Any& _rEnumValue ) const;
 114
 115         // IReference implementqation
 116         virtual oslInterlockedCount SAL_CALL acquire();
 117         virtual oslInterlockedCount SAL_CALL release();
 118
 119     private:
 120         DefaultEnumRepresentation();                                                // never implemented
 121         DefaultEnumRepresentation( const DefaultEnumRepresentation& );              // never implemented
 122         DefaultEnumRepresentation& operator=( const DefaultEnumRepresentation& );   // never implemented
 123     };
 124
 125     //========================================================================
 126     //= UI flags (for all browseable properties)
 127     //========================================================================
 128
 129 #define PROP_FLAG_NONE              0x00000000  // no special flag
 130 #define PROP_FLAG_FORM_VISIBLE      0x00000001  // the property is visible when inspecting a form object
 131 #define PROP_FLAG_DIALOG_VISIBLE    0x00000002  // the property is visible when inspecting a dialog object
 132 #define PROP_FLAG_DATA_PROPERTY     0x00000004  // the property is to appear on the "Data" page
 133 #define PROP_FLAG_ENUM              0x00000020  // the property is some kind of enum property, i.e. its
 134                                                 // value is chosen from a fixed list of possible values
 135 #define PROP_FLAG_ENUM_ONE          0x00000060  // the property is an enum property starting with 1
 136                                                 //  (note that this includes PROP_FLAG_ENUM)
 137 #define PROP_FLAG_COMPOSEABLE       0x00000080  // the property is "composeable", i.e. an intersection of property
 138                                                 //  sets should expose it, if all elements do
 139 #define PROP_FLAG_EXPERIMENTAL      0x00000100  // the property is experimental, i.e. should not appear in the
 140                                                 // UI, unless experimental properties are enabled by a configuraiton
 141                                                 // option
 142
 143     //========================================================================
 144     //= property ids (for all browseable properties)
 145     //========================================================================
 146
 147     #define PROPERTY_ID_NAME                              1
 148     #define PROPERTY_ID_LABEL                             2
 149     #define PROPERTY_ID_CONTROLLABEL              3
 150     #define PROPERTY_ID_MAXTEXTLEN                        4
 151     #define PROPERTY_ID_EDITMASK                          5
 152     #define PROPERTY_ID_LITERALMASK                       6
 153     #define PROPERTY_ID_STRICTFORMAT              7
 154     #define PROPERTY_ID_ENABLED                           8
 155     #define PROPERTY_ID_READONLY                          9
 156     #define PROPERTY_ID_PRINTABLE                        10
 157     #define PROPERTY_ID_CONTROLSOURCE            11
 158     #define PROPERTY_ID_TABSTOP                          12
 159     #define PROPERTY_ID_TABINDEX                         13
 160     #define PROPERTY_ID_DATASOURCE                       14
 161     #define PROPERTY_ID_COMMAND                          15
 162     #define PROPERTY_ID_COMMANDTYPE                      16
 163     #define PROPERTY_ID_FILTER               17
 164     #define PROPERTY_ID_SORT                             18
 165     #define PROPERTY_ID_INSERTONLY                       19
 166     #define PROPERTY_ID_ALLOWADDITIONS           20
 167     #define PROPERTY_ID_ALLOWEDITS                       21
 168     #define PROPERTY_ID_ALLOWDELETIONS           22
 169         #define PROPERTY_ID_GROUP_NAME                   23
 170     #define PROPERTY_ID_NAVIGATION                       24
 171     #define PROPERTY_ID_CYCLE                            25
 172     #define PROPERTY_ID_HIDDEN_VALUE             26
 173     #define PROPERTY_ID_VALUEMIN                         27
 174     #define PROPERTY_ID_VALUEMAX                         28
 175     #define PROPERTY_ID_VALUESTEP                        29
 176     #define PROPERTY_ID_DEFAULT_VALUE            30
 177     #define PROPERTY_ID_DECIMAL_ACCURACY         31
 178     #define PROPERTY_ID_SHOWTHOUSANDSEP          32
 179     #define PROPERTY_ID_REFVALUE                         33
 180     #define PROPERTY_ID_CURRENCYSYMBOL           34
 181     #define PROPERTY_ID_CURRSYM_POSITION         35
 182     #define PROPERTY_ID_DATEMIN                          36
 183     #define PROPERTY_ID_DATEMAX                          37
 184     #define PROPERTY_ID_DATEFORMAT                       38
 185     #define PROPERTY_ID_SELECTEDITEMS        39
 186     #define PROPERTY_ID_DEFAULT_DATE             40
 187     #define PROPERTY_ID_TIMEMIN                          41
 188     #define PROPERTY_ID_TIMEMAX                          42
 189     #define PROPERTY_ID_TIMEFORMAT                       43
 190     #define PROPERTY_ID_DEFAULT_TIME             44
 191     #define PROPERTY_ID_EFFECTIVE_MIN            45
 192     #define PROPERTY_ID_EFFECTIVE_MAX            46
 193     #define PROPERTY_ID_EFFECTIVE_DEFAULT        47
 194     #define PROPERTY_ID_FORMATKEY                        48
 195     #define PROPERTY_ID_CLASSID                          50
 196     #define PROPERTY_ID_HEIGHT                           51
 197     #define PROPERTY_ID_WIDTH                            52
 198     #define PROPERTY_ID_BOUNDCOLUMN                      53
 199     #define PROPERTY_ID_LISTSOURCETYPE           54
 200     #define PROPERTY_ID_LISTSOURCE                       55
 201     #define PROPERTY_ID_LISTINDEX                        56
 202     #define PROPERTY_ID_STRINGITEMLIST           57
 203     #define PROPERTY_ID_DEFAULT_TEXT             58
 204     #define PROPERTY_ID_FONT                 59
 205     #define PROPERTY_ID_ALIGN                            60
 206     #define PROPERTY_ID_ROWHEIGHT                        61
 207     #define PROPERTY_ID_BACKGROUNDCOLOR          62
 208     #define PROPERTY_ID_FILLCOLOR                        63
 209     #define PROPERTY_ID_ESCAPE_PROCESSING        64
 210     #define PROPERTY_ID_LINECOLOR                        65
 211     #define PROPERTY_ID_BORDER                           66
 212     #define PROPERTY_ID_DROPDOWN                         67
 213     #define PROPERTY_ID_AUTOCOMPLETE             68
 214     #define PROPERTY_ID_LINECOUNT                        69
 215     #define PROPERTY_ID_WORDBREAK            70
 216     #define PROPERTY_ID_MULTILINE                        71
 217     #define PROPERTY_ID_MULTISELECTION           72
 218     #define PROPERTY_ID_AUTOLINEBREAK        73
 219     #define PROPERTY_ID_HSCROLL                          74
 220     #define PROPERTY_ID_VSCROLL                          75
 221     #define PROPERTY_ID_SPIN                             76
 222     #define PROPERTY_ID_BUTTONTYPE                       77
 223     #define PROPERTY_ID_TARGET_URL                       78
 224     #define PROPERTY_ID_TARGET_FRAME             79
 225     #define PROPERTY_ID_SUBMIT_ACTION            80
 226     #define PROPERTY_ID_SUBMIT_TARGET            81
 227     #define PROPERTY_ID_SUBMIT_METHOD            82
 228     #define PROPERTY_ID_SUBMIT_ENCODING          83
 229     #define PROPERTY_ID_DEFAULT_STATE            84
 230     #define PROPERTY_ID_DEFAULTBUTTON            85
 231     #define PROPERTY_ID_IMAGE_URL                        86
 232     #define PROPERTY_ID_DEFAULT_SELECT_SEQ       87
 233     #define PROPERTY_ID_ECHO_CHAR                        88
 234     #define PROPERTY_ID_EMPTY_IS_NULL            89
 235     #define PROPERTY_ID_TRISTATE                         90
 236     #define PROPERTY_ID_MASTERFIELDS             91
 237     #define PROPERTY_ID_DETAILFIELDS             92
 238     #define PROPERTY_ID_RECORDMARKER             93
 239     #define PROPERTY_ID_FILTERPROPOSAL           94
 240     #define PROPERTY_ID_TAG                                      95
 241     #define PROPERTY_ID_HELPTEXT                         96
 242     #define PROPERTY_ID_HELPURL                          97
 243     #define PROPERTY_ID_HASNAVIGATION            98
 244     #define PROPERTY_ID_POSITIONX                        99
 245     #define PROPERTY_ID_POSITIONY                        100
 246     #define PROPERTY_ID_TITLE                            101
 247     #define PROPERTY_ID_STEP                             102
 248     #define PROPERTY_ID_PROGRESSVALUE            103
 249     #define PROPERTY_ID_PROGRESSVALUE_MIN        104
 250     #define PROPERTY_ID_PROGRESSVALUE_MAX        105
 251     #define PROPERTY_ID_SCROLLVALUE                      106
 252     #define PROPERTY_ID_SCROLLVALUE_MAX          107
 253     #define PROPERTY_ID_LINEINCREMENT            108
 254     #define PROPERTY_ID_BLOCKINCREMENT           109
 255     #define PROPERTY_ID_VISIBLESIZE                      110
 256     #define PROPERTY_ID_ORIENTATION                      111
 257     #define PROPERTY_ID_IMAGEPOSITION        112
 258     #define PROPERTY_ID_DATE                         113
 259     #define PROPERTY_ID_STATE                        114
 260     #define PROPERTY_ID_TIME                         115
 261     #define PROPERTY_ID_VALUE                        116
 262     #define PROPERTY_ID_SCALEIMAGE                   117
 263     #define PROPERTY_ID_PUSHBUTTONTYPE       118
 264     #define PROPERTY_ID_EFFECTIVE_VALUE          119
 265     #define PROPERTY_ID_TEXT                     120
 266     #define PROPERTY_ID_BOUND_CELL           121
 267     #define PROPERTY_ID_LIST_CELL_RANGE      122
 268     #define PROPERTY_ID_CELL_EXCHANGE_TYPE   123
 269     #define PROPERTY_ID_SCROLLVALUE_MIN      124
 270     #define PROPERTY_ID_DEFAULT_SCROLLVALUE  125
 271     #define PROPERTY_ID_REPEAT_DELAY         126
 272     #define PROPERTY_ID_SYMBOLCOLOR          127
 273     #define PROPERTY_ID_SPINVALUE            128
 274     #define PROPERTY_ID_SPINVALUE_MIN        129
 275     #define PROPERTY_ID_SPINVALUE_MAX        130
 276     #define PROPERTY_ID_DEFAULT_SPINVALUE    131
 277     #define PROPERTY_ID_SPININCREMENT        132
 278     #define PROPERTY_ID_REPEAT               133
 279     #define PROPERTY_ID_SHOW_SCROLLBARS      134
 280     #define PROPERTY_ID_ICONSIZE             135
 281     #define PROPERTY_ID_SHOW_POSITION        136
 282     #define PROPERTY_ID_SHOW_NAVIGATION      137
 283     #define PROPERTY_ID_SHOW_RECORDACTIONS   138
 284     #define PROPERTY_ID_SHOW_FILTERSORT      139
 285     #define PROPERTY_ID_TEXTTYPE             140
 286     #define PROPERTY_ID_LINEEND_FORMAT       141
 287     #define PROPERTY_ID_TOGGLE               142
 288     #define PROPERTY_ID_FOCUSONCLICK         143
 289     #define PROPERTY_ID_HIDEINACTIVESELECTION 144
 290     #define PROPERTY_ID_VISUALEFFECT         145
 291     #define PROPERTY_ID_BORDERCOLOR          146
 292     #define PROPERTY_ID_XML_DATA_MODEL       147
 293     #define PROPERTY_ID_BIND_EXPRESSION      148
 294     #define PROPERTY_ID_XSD_REQUIRED         149
 295     #define PROPERTY_ID_XSD_RELEVANT         150
 296     #define PROPERTY_ID_XSD_READONLY         151
 297     #define PROPERTY_ID_XSD_CONSTRAINT       152
 298     #define PROPERTY_ID_XSD_CALCULATION      153
 299     #define PROPERTY_ID_XSD_DATA_TYPE        154
 300     #define PROPERTY_ID_XSD_WHITESPACES      155
 301     #define PROPERTY_ID_XSD_PATTERN          156
 302     #define PROPERTY_ID_XSD_LENGTH           157
 303     #define PROPERTY_ID_XSD_MIN_LENGTH       158
 304     #define PROPERTY_ID_XSD_MAX_LENGTH       159
 305     #define PROPERTY_ID_XSD_TOTAL_DIGITS     160
 306     #define PROPERTY_ID_XSD_FRACTION_DIGITS  161
 307     #define PROPERTY_ID_XSD_MAX_INCLUSIVE_INT        162
 308     #define PROPERTY_ID_XSD_MAX_EXCLUSIVE_INT        163
 309     #define PROPERTY_ID_XSD_MIN_INCLUSIVE_INT        164
 310     #define PROPERTY_ID_XSD_MIN_EXCLUSIVE_INT        165
 311     #define PROPERTY_ID_XSD_MAX_INCLUSIVE_DOUBLE     166
 312     #define PROPERTY_ID_XSD_MAX_EXCLUSIVE_DOUBLE     167
 313     #define PROPERTY_ID_XSD_MIN_INCLUSIVE_DOUBLE     168
 314     #define PROPERTY_ID_XSD_MIN_EXCLUSIVE_DOUBLE     169
 315     #define PROPERTY_ID_XSD_MAX_INCLUSIVE_DATE       170
 316     #define PROPERTY_ID_XSD_MAX_EXCLUSIVE_DATE       171
 317     #define PROPERTY_ID_XSD_MIN_INCLUSIVE_DATE       172
 318     #define PROPERTY_ID_XSD_MIN_EXCLUSIVE_DATE       173
 319     #define PROPERTY_ID_XSD_MAX_INCLUSIVE_TIME       174
 320     #define PROPERTY_ID_XSD_MAX_EXCLUSIVE_TIME       175
 321     #define PROPERTY_ID_XSD_MIN_INCLUSIVE_TIME       176
 322     #define PROPERTY_ID_XSD_MIN_EXCLUSIVE_TIME       177
 323     #define PROPERTY_ID_XSD_MAX_INCLUSIVE_DATE_TIME  178
 324     #define PROPERTY_ID_XSD_MAX_EXCLUSIVE_DATE_TIME  179
 325     #define PROPERTY_ID_XSD_MIN_INCLUSIVE_DATE_TIME  180
 326     #define PROPERTY_ID_XSD_MIN_EXCLUSIVE_DATE_TIME  181
 327     #define PROPERTY_ID_UNCHECKEDREFVALUE           182
 328     #define PROPERTY_ID_SUBMISSION_ID               183
 329     #define PROPERTY_ID_XFORMS_BUTTONTYPE           184
 330     #define PROPERTY_ID_LIST_BINDING                185
 331     #define PROPERTY_ID_VERTICAL_ALIGN              186
 332     #define PROPERTY_ID_BINDING_NAME                187
 333     #define PROPERTY_ID_DECORATION                  188
 334     #define PROPERTY_ID_SELECTION_TYPE                          189
 335     #define PROPERTY_ID_ROOT_DISPLAYED                          190
 336     #define PROPERTY_ID_SHOWS_HANDLES                           191
 337     #define PROPERTY_ID_SHOWS_ROOT_HANDLES                      192
 338     #define PROPERTY_ID_EDITABLE                                        193
 339     #define PROPERTY_ID_INVOKES_STOP_NOT_EDITING    194
 340     #define PROPERTY_ID_NOLABEL                                 195
 341     #define PROPERTY_ID_SCALE_MODE                  196
 342     #define PROPERTY_ID_INPUT_REQUIRED              197
 343     #define PROPERTY_ID_WRITING_MODE                198
 344     #define PROPERTY_ID_ENABLE_VISIBLE              199
 345     #define PROPERTY_ID_WHEEL_BEHAVIOR              200
 346     #define PROPERTY_ID_TEXT_ANCHOR_TYPE            201
 347     #define PROPERTY_ID_SHEET_ANCHOR_TYPE           202
 348
 349 //............................................................................
 350 } // namespace pcr
 351 //............................................................................
 352
 353 #endif // _EXTENSIONS_PROPCTRLR_FORMMETADATA_HXX_
 354