xmloff/source/forms/valueproperties.hxx

   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 #ifndef _XMLOFF_FORMS_VALUEPROPERTIES_HXX_
  21 #define _XMLOFF_FORMS_VALUEPROPERTIES_HXX_
  22
  23 #include "controlelement.hxx"
  24
  25 //.........................................................................
  26 namespace xmloff
  27 {
  28 //.........................................................................
  29
  30     //=====================================================================
  31     //= OValuePropertiesMetaData
  32     //=====================================================================
  33     class OValuePropertiesMetaData
  34     {
  35     protected:
  36         OValuePropertiesMetaData() { }
  37
  38     public:
  39         /** calculate the property names for the <em>current-value</em> and the <em>value</em> attribute.
  40
  41             <p>If controls of the given FormComponentType do not have any of the properties requested,
  42             the respective out parameter will be set to NULL.</p>
  43         */
  44         static void getValuePropertyNames(
  45             OControlElement::ElementType _eType,
  46             sal_Int16 _nFormComponentType,
  47             sal_Char const * & _rpCurrentValuePropertyName,
  48             sal_Char const * & _rpValuePropertyName);
  49
  50         /** calculate the property names for the <em>min-value</em> and the <em>max-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 getValueLimitPropertyNames(
  56             sal_Int16 _nFormComponentType,
  57             sal_Char const * & _rpMinValuePropertyName,
  58             sal_Char const * & _rpMaxValuePropertyName);
  59
  60         /** calculate the names of the properties which, at runtime, are used for <em>value</em> and
  61             <em>default value</em>.
  62         */
  63         static void getRuntimeValuePropertyNames(
  64             OControlElement::ElementType _eType,
  65             sal_Int16 _nFormComponentType,
  66             sal_Char const * & _rpValuePropertyName,
  67             sal_Char const * & _rpDefaultValuePropertyName);
  68     };
  69
  70 //.........................................................................
  71 }   // namespace xmloff
  72 //.........................................................................
  73
  74 #endif // _XMLOFF_FORMS_VALUEPROPERTIES_HXX_
  75
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */