xmloff/source/forms/valueproperties.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: valueproperties.hxx,v $
  10  * $Revision: 1.5 $
  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 _XMLOFF_FORMS_VALUEPROPERTIES_HXX_
  32 #define _XMLOFF_FORMS_VALUEPROPERTIES_HXX_
  33
  34 #include "controlelement.hxx"
  35
  36 //.........................................................................
  37 namespace xmloff
  38 {
  39 //.........................................................................
  40
  41     //=====================================================================
  42     //= OValuePropertiesMetaData
  43     //=====================================================================
  44     class OValuePropertiesMetaData
  45     {
  46     protected:
  47         OValuePropertiesMetaData() { }
  48
  49     public:
  50         /** calculate the property names for the <em>current-value</em> and the <em>value</em> attribute.
  51
  52             <p>If controls of the given FormComponentType do not have any of the properties requested,
  53             the respective out parameter will be set to NULL.</p>
  54         */
  55         static void getValuePropertyNames(
  56             OControlElement::ElementType _eType,
  57             sal_Int16 _nFormComponentType,
  58             sal_Char const * & _rpCurrentValuePropertyName,
  59             sal_Char const * & _rpValuePropertyName);
  60
  61         /** calculate the property names for the <em>min-value</em> and the <em>max-value</em> attribute.
  62
  63             <p>If controls of the given FormComponentType do not have any of the properties requested,
  64             the respective out parameter will be set to NULL.</p>
  65         */
  66         static void getValueLimitPropertyNames(
  67             sal_Int16 _nFormComponentType,
  68             sal_Char const * & _rpMinValuePropertyName,
  69             sal_Char const * & _rpMaxValuePropertyName);
  70
  71         /** calculate the names of the properties which, at runtime, are used for <em>value</em> and
  72             <em>default value</em>.
  73         */
  74         static void getRuntimeValuePropertyNames(
  75             OControlElement::ElementType _eType,
  76             sal_Int16 _nFormComponentType,
  77             sal_Char const * & _rpValuePropertyName,
  78             sal_Char const * & _rpDefaultValuePropertyName);
  79     };
  80
  81 //.........................................................................
  82 }       // namespace xmloff
  83 //.........................................................................
  84
  85 #endif // _XMLOFF_FORMS_VALUEPROPERTIES_HXX_
  86
  87