xmloff/source/forms/controlelement.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: controlelement.hxx,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _XMLOFF_FORMS_CONTROLELEMENT_HXX_
  32 #define _XMLOFF_FORMS_CONTROLELEMENT_HXX_
  33
  34 #include <sal/types.h>
  35
  36 //.........................................................................
  37 namespace xmloff
  38 {
  39 //.........................................................................
  40
  41     //=====================================================================
  42     //= OControlElement
  43     //=====================================================================
  44     /** helper for translating between control types and XML tags
  45     */
  46     class OControlElement
  47     {
  48     public:
  49         enum ElementType
  50         {
  51             TEXT = 0,
  52             TEXT_AREA,
  53             PASSWORD,
  54             FILE,
  55             FORMATTED_TEXT,
  56             FIXED_TEXT,
  57             COMBOBOX,
  58             LISTBOX,
  59             BUTTON,
  60             IMAGE,
  61             CHECKBOX,
  62             RADIO,
  63             FRAME,
  64             IMAGE_FRAME,
  65             HIDDEN,
  66             GRID,
  67             VALUERANGE,
  68             GENERIC_CONTROL,
  69
  70             UNKNOWN     // must be the last element
  71         };
  72
  73     protected:
  74         /** ctor.
  75             <p>This default constructor is protected, 'cause this class is not intended to be instantiated
  76             directly. Instead, the derived classes should be used.</p>
  77         */
  78         OControlElement() { }
  79
  80     public:
  81         /** retrieves the tag name to be used to describe a control of the given type
  82
  83             <p>The retuned string is the pure element name, without any namespace.</p>
  84
  85             @param      _eType
  86                 the element type
  87         */
  88         static const sal_Char* getElementName(ElementType _eType);
  89     };
  90
  91 //.........................................................................
  92 }       // namespace xmloff
  93 //.........................................................................
  94
  95 #endif // _XMLOFF_FORMS_CONTROLELEMENT_HXX_
  96