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