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