xmloff/source/forms/controlelement.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_CONTROLELEMENT_HXX_
  21 #define _XMLOFF_FORMS_CONTROLELEMENT_HXX_
  22
  23 #include <sal/types.h>
  24
  25 //.........................................................................
  26 namespace xmloff
  27 {
  28 //.........................................................................
  29
  30     //=====================================================================
  31     //= OControlElement
  32     //=====================================================================
  33     /** helper for translating between control types and XML tags
  34     */
  35     class OControlElement
  36     {
  37     public:
  38         enum ElementType
  39         {
  40             TEXT = 0,
  41             TEXT_AREA,
  42             PASSWORD,
  43             FILE,
  44             FORMATTED_TEXT,
  45             FIXED_TEXT,
  46             COMBOBOX,
  47             LISTBOX,
  48             BUTTON,
  49             IMAGE,
  50             CHECKBOX,
  51             RADIO,
  52             FRAME,
  53             IMAGE_FRAME,
  54             HIDDEN,
  55             GRID,
  56             VALUERANGE,
  57             GENERIC_CONTROL,
  58             TIME,
  59             DATE,
  60
  61             UNKNOWN // must be the last element
  62         };
  63
  64     protected:
  65         /** ctor.
  66             <p>This default constructor is protected, 'cause this class is not intended to be instantiated
  67             directly. Instead, the derived classes should be used.</p>
  68         */
  69         OControlElement() { }
  70
  71     public:
  72         /** retrieves the tag name to be used to describe a control of the given type
  73
  74             <p>The retuned string is the pure element name, without any namespace.</p>
  75
  76             @param  _eType
  77                 the element type
  78         */
  79         static const sal_Char* getElementName(ElementType _eType);
  80     };
  81
  82 //.........................................................................
  83 }   // namespace xmloff
  84 //.........................................................................
  85
  86 #endif // _XMLOFF_FORMS_CONTROLELEMENT_HXX_
  87
  88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */