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