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