xref: /aoo41x/main/framework/inc/arguments.h (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef __FRAMEWORK_ARGUMENTS_H_
29*cdf0e10cSrcweir #define __FRAMEWORK_ARGUMENTS_H_
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
32*cdf0e10cSrcweir //	includes
33*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir #include <macros/generic.hxx>
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
38*cdf0e10cSrcweir //	namespace
39*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
40*cdf0e10cSrcweir 
41*cdf0e10cSrcweir namespace framework{
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir /*-************************************************************************************************************//**
44*cdf0e10cSrcweir 	@short			These arguments are included in given parameter lists - e.g. at dispatch calls at Sequence< PropertyValue >.
45*cdf0e10cSrcweir 					You can use class ArgumentAnalyzer to set/get it from a given list!
46*cdf0e10cSrcweir *//*-*************************************************************************************************************/
47*cdf0e10cSrcweir 
48*cdf0e10cSrcweir #define ARGUMENTNAME_ASTEMPLATE                             DECLARE_ASCII("AsTemplate"          )   // bool
49*cdf0e10cSrcweir #define ARGUMENTNAME_CHARACTERSET                           DECLARE_ASCII("CharacterSet"        )   // string
50*cdf0e10cSrcweir #define ARGUMENTNAME_DEEPDETECTION                          DECLARE_ASCII("DeepDetection"       )   // bool
51*cdf0e10cSrcweir #define ARGUMENTNAME_DETECTSERVICE                          DECLARE_ASCII("DetectService"       )   // string
52*cdf0e10cSrcweir #define ARGUMENTNAME_EXTENSION                              DECLARE_ASCII("Extension"           )   // string
53*cdf0e10cSrcweir #define ARGUMENTNAME_FILTERNAME                             DECLARE_ASCII("FilterName"          )   // string
54*cdf0e10cSrcweir #define ARGUMENTNAME_FILTEROPTIONS                          DECLARE_ASCII("FilterOptions"       )   // string
55*cdf0e10cSrcweir #define ARGUMENTNAME_FORMAT                                 DECLARE_ASCII("Format"              )   // string
56*cdf0e10cSrcweir #define ARGUMENTNAME_FRAMENAME                              DECLARE_ASCII("FrameName"           )   // string
57*cdf0e10cSrcweir #define ARGUMENTNAME_HIDDEN                                 DECLARE_ASCII("Hidden"              )   // bool
58*cdf0e10cSrcweir #define ARGUMENTNAME_INPUTSTREAM                            DECLARE_ASCII("InputStream"         )   // Reference< XInputStream >
59*cdf0e10cSrcweir #define ARGUMENTNAME_INTERACTIONHANDLER                     DECLARE_ASCII("InteractionHandler"  )   // Reference< XInteractionHandler >
60*cdf0e10cSrcweir #define ARGUMENTNAME_JUMPMARK                               DECLARE_ASCII("JumpMark"            )   // string
61*cdf0e10cSrcweir #define ARGUMENTNAME_MACROEXECUTIONMODE                     DECLARE_ASCII("MacroExecutionMode"  )   // int16
62*cdf0e10cSrcweir #define ARGUMENTNAME_MEDIATYPE                              DECLARE_ASCII("MediaType"           )   // string
63*cdf0e10cSrcweir #define ARGUMENTNAME_MINIMIZED                              DECLARE_ASCII("Minimized"           )   // bool
64*cdf0e10cSrcweir #define ARGUMENTNAME_OPENNEWVIEW                            DECLARE_ASCII("OpenNewView"         )   // bool
65*cdf0e10cSrcweir #define ARGUMENTNAME_OUTPUTSTREAM                           DECLARE_ASCII("OutputStream"        )   // Reference< XOutputStream >
66*cdf0e10cSrcweir #define ARGUMENTNAME_PATTERN                                DECLARE_ASCII("Pattern"             )   // string
67*cdf0e10cSrcweir #define ARGUMENTNAME_POSSIZE                                DECLARE_ASCII("PosSize"             )   // rectangle
68*cdf0e10cSrcweir #define ARGUMENTNAME_POSTDATA                               DECLARE_ASCII("PostData"            )   // Reference< XInputStream >
69*cdf0e10cSrcweir #define ARGUMENTNAME_POSTSTRING                             DECLARE_ASCII("PostString"          )   // string
70*cdf0e10cSrcweir #define ARGUMENTNAME_PREVIEW                                DECLARE_ASCII("Preview"             )   // bool
71*cdf0e10cSrcweir #define ARGUMENTNAME_READONLY                               DECLARE_ASCII("ReadOnly"            )   // bool
72*cdf0e10cSrcweir #define ARGUMENTNAME_REFERRER                               DECLARE_ASCII("Referer"             )   // string
73*cdf0e10cSrcweir #define ARGUMENTNAME_SILENT                                 DECLARE_ASCII("Silent"              )   // bool
74*cdf0e10cSrcweir #define ARGUMENTNAME_STATUSINDICATOR                        DECLARE_ASCII("StatusIndicator"     )   // Reference< XStatusIndicator >
75*cdf0e10cSrcweir #define ARGUMENTNAME_TEMPLATENAME                           DECLARE_ASCII("TemplateName"        )   // string
76*cdf0e10cSrcweir #define ARGUMENTNAME_TEMPLATEREGIONNAME                     DECLARE_ASCII("TemplateRegionName"  )   // string
77*cdf0e10cSrcweir #define ARGUMENTNAME_TYPENAME                               DECLARE_ASCII("TypeName"            )   // string
78*cdf0e10cSrcweir #define ARGUMENTNAME_UPDATEDOCMODE                          DECLARE_ASCII("UpdateDocMode"       )   // int16
79*cdf0e10cSrcweir #define ARGUMENTNAME_URL                                    DECLARE_ASCII("URL"                 )   // string
80*cdf0e10cSrcweir #define ARGUMENTNAME_VERSION                                DECLARE_ASCII("Version"             )   // int16
81*cdf0e10cSrcweir #define ARGUMENTNAME_VIEWID                                 DECLARE_ASCII("ViewId"              )   // int16
82*cdf0e10cSrcweir #define ARGUMENTNAME_REPAIRPACKAGE                          DECLARE_ASCII("RepairPackage"       )   // bool
83*cdf0e10cSrcweir #define ARGUMENTNAME_DOCUMENTTITLE                          DECLARE_ASCII("DocumentTitle"       )   // string
84*cdf0e10cSrcweir 
85*cdf0e10cSrcweir /*-************************************************************************************************************//**
86*cdf0e10cSrcweir     @short          define our argument mask
87*cdf0e10cSrcweir     @descr          These mask could be used to define a subset for analyzing arguments or specify
88*cdf0e10cSrcweir                     one argument for set/get operations.
89*cdf0e10cSrcweir                     We use first byte [bit 0..7] of an int32 to define 8 layer, and follow 3 bytes [bit 8..31]
90*cdf0e10cSrcweir                     to address 24 properties per layer! Please use defines to build these mask!!!
91*cdf0e10cSrcweir                     With these values we build an special enum field for better using at our Argumentanalyzer-interface ...
92*cdf0e10cSrcweir                     Special define ANALYZE_ALL is our default for analyzing. Then we analyze complete argument list.
93*cdf0e10cSrcweir *//*-*************************************************************************************************************/
94*cdf0e10cSrcweir #define ARGUMENTLAYER_1                                     0x00000001
95*cdf0e10cSrcweir #define ARGUMENTLAYER_2                                     0x00000002
96*cdf0e10cSrcweir #define ARGUMENTLAYER_3                                     0x00000004
97*cdf0e10cSrcweir #define ARGUMENTLAYER_4                                     0x00000008
98*cdf0e10cSrcweir #define ARGUMENTLAYER_5                                     0x00000010
99*cdf0e10cSrcweir #define ARGUMENTLAYER_6                                     0x00000020
100*cdf0e10cSrcweir #define ARGUMENTLAYER_7                                     0x00000040
101*cdf0e10cSrcweir #define ARGUMENTLAYER_8                                     0x00000080
102*cdf0e10cSrcweir 
103*cdf0e10cSrcweir #define ARGUMENTFLAG_1                                      0x00000100
104*cdf0e10cSrcweir #define ARGUMENTFLAG_2                                      0x00000200
105*cdf0e10cSrcweir #define ARGUMENTFLAG_3                                      0x00000400
106*cdf0e10cSrcweir #define ARGUMENTFLAG_4                                      0x00000800
107*cdf0e10cSrcweir #define ARGUMENTFLAG_5                                      0x00001000
108*cdf0e10cSrcweir #define ARGUMENTFLAG_6                                      0x00002000
109*cdf0e10cSrcweir #define ARGUMENTFLAG_7                                      0x00004000
110*cdf0e10cSrcweir #define ARGUMENTFLAG_8                                      0x00008000
111*cdf0e10cSrcweir #define ARGUMENTFLAG_9                                      0x00010000
112*cdf0e10cSrcweir #define ARGUMENTFLAG_10                                     0x00020000
113*cdf0e10cSrcweir #define ARGUMENTFLAG_11                                     0x00040000
114*cdf0e10cSrcweir #define ARGUMENTFLAG_12                                     0x00080000
115*cdf0e10cSrcweir #define ARGUMENTFLAG_13                                     0x00100000
116*cdf0e10cSrcweir #define ARGUMENTFLAG_14                                     0x00200000
117*cdf0e10cSrcweir #define ARGUMENTFLAG_15                                     0x00400000
118*cdf0e10cSrcweir #define ARGUMENTFLAG_16                                     0x00800000
119*cdf0e10cSrcweir #define ARGUMENTFLAG_17                                     0x01000000
120*cdf0e10cSrcweir #define ARGUMENTFLAG_18                                     0x02000000
121*cdf0e10cSrcweir #define ARGUMENTFLAG_19                                     0x04000000
122*cdf0e10cSrcweir #define ARGUMENTFLAG_20                                     0x08000000
123*cdf0e10cSrcweir #define ARGUMENTFLAG_21                                     0x10000000
124*cdf0e10cSrcweir #define ARGUMENTFLAG_22                                     0x20000000
125*cdf0e10cSrcweir #define ARGUMENTFLAG_23                                     0x40000000
126*cdf0e10cSrcweir #define ARGUMENTFLAG_24                                     0x80000000
127*cdf0e10cSrcweir 
128*cdf0e10cSrcweir #define ANALYZE_ALL_ARGUMENTS                               0xFFFFFFFF
129*cdf0e10cSrcweir 
130*cdf0e10cSrcweir enum EArgument
131*cdf0e10cSrcweir {
132*cdf0e10cSrcweir     E_ASTEMPLATE            = ARGUMENTLAYER_1 | ARGUMENTFLAG_1 ,
133*cdf0e10cSrcweir     E_CHARACTERSET          = ARGUMENTLAYER_1 | ARGUMENTFLAG_2 ,
134*cdf0e10cSrcweir     E_DEEPDETECTION         = ARGUMENTLAYER_1 | ARGUMENTFLAG_3 ,
135*cdf0e10cSrcweir     E_DETECTSERVICE         = ARGUMENTLAYER_1 | ARGUMENTFLAG_4 ,
136*cdf0e10cSrcweir     E_EXTENSION             = ARGUMENTLAYER_1 | ARGUMENTFLAG_5 ,
137*cdf0e10cSrcweir     E_FILTERNAME            = ARGUMENTLAYER_1 | ARGUMENTFLAG_6 ,
138*cdf0e10cSrcweir     E_FILTEROPTIONS         = ARGUMENTLAYER_1 | ARGUMENTFLAG_7 ,
139*cdf0e10cSrcweir     E_FORMAT                = ARGUMENTLAYER_1 | ARGUMENTFLAG_8 ,
140*cdf0e10cSrcweir     E_FRAMENAME             = ARGUMENTLAYER_1 | ARGUMENTFLAG_9 ,
141*cdf0e10cSrcweir     E_HIDDEN                = ARGUMENTLAYER_1 | ARGUMENTFLAG_10,
142*cdf0e10cSrcweir     E_INPUTSTREAM           = ARGUMENTLAYER_1 | ARGUMENTFLAG_11,
143*cdf0e10cSrcweir     E_INTERACTIONHANDLER    = ARGUMENTLAYER_1 | ARGUMENTFLAG_12,
144*cdf0e10cSrcweir     E_JUMPMARK              = ARGUMENTLAYER_1 | ARGUMENTFLAG_13,
145*cdf0e10cSrcweir     E_MACROEXECUTIONMODE    = ARGUMENTLAYER_1 | ARGUMENTFLAG_14,
146*cdf0e10cSrcweir     E_MEDIATYPE             = ARGUMENTLAYER_1 | ARGUMENTFLAG_15,
147*cdf0e10cSrcweir     E_MINIMIZED             = ARGUMENTLAYER_1 | ARGUMENTFLAG_16,
148*cdf0e10cSrcweir     E_OPENNEWVIEW           = ARGUMENTLAYER_1 | ARGUMENTFLAG_17,
149*cdf0e10cSrcweir     E_OUTPUTSTREAM          = ARGUMENTLAYER_1 | ARGUMENTFLAG_18,
150*cdf0e10cSrcweir     E_PATTERN               = ARGUMENTLAYER_1 | ARGUMENTFLAG_19,
151*cdf0e10cSrcweir     E_POSSIZE               = ARGUMENTLAYER_1 | ARGUMENTFLAG_20,
152*cdf0e10cSrcweir     E_POSTDATA              = ARGUMENTLAYER_1 | ARGUMENTFLAG_21,
153*cdf0e10cSrcweir     E_POSTSTRING            = ARGUMENTLAYER_1 | ARGUMENTFLAG_22,
154*cdf0e10cSrcweir     E_PREVIEW               = ARGUMENTLAYER_1 | ARGUMENTFLAG_23,
155*cdf0e10cSrcweir     E_READONLY              = ARGUMENTLAYER_1 | ARGUMENTFLAG_24,
156*cdf0e10cSrcweir 
157*cdf0e10cSrcweir     E_REFERRER              = ARGUMENTLAYER_2 | ARGUMENTFLAG_1 ,
158*cdf0e10cSrcweir     E_SILENT                = ARGUMENTLAYER_2 | ARGUMENTFLAG_2 ,
159*cdf0e10cSrcweir     E_STATUSINDICATOR       = ARGUMENTLAYER_2 | ARGUMENTFLAG_3 ,
160*cdf0e10cSrcweir     E_TEMPLATENAME          = ARGUMENTLAYER_2 | ARGUMENTFLAG_4 ,
161*cdf0e10cSrcweir     E_TEMPLATEREGIONNAME    = ARGUMENTLAYER_2 | ARGUMENTFLAG_5 ,
162*cdf0e10cSrcweir     E_TYPENAME              = ARGUMENTLAYER_2 | ARGUMENTFLAG_6 ,
163*cdf0e10cSrcweir     E_UPDATEDOCMODE         = ARGUMENTLAYER_2 | ARGUMENTFLAG_7 ,
164*cdf0e10cSrcweir     E_URL                   = ARGUMENTLAYER_2 | ARGUMENTFLAG_8 ,
165*cdf0e10cSrcweir     E_VERSION               = ARGUMENTLAYER_2 | ARGUMENTFLAG_9 ,
166*cdf0e10cSrcweir     E_VIEWID                = ARGUMENTLAYER_2 | ARGUMENTFLAG_10,
167*cdf0e10cSrcweir     E_REPAIRPACKAGE         = ARGUMENTLAYER_2 | ARGUMENTFLAG_11,
168*cdf0e10cSrcweir     E_DOCUMENTTITLE         = ARGUMENTLAYER_2 | ARGUMENTFLAG_12
169*cdf0e10cSrcweir };
170*cdf0e10cSrcweir 
171*cdf0e10cSrcweir } // namespace framework
172*cdf0e10cSrcweir 
173*cdf0e10cSrcweir #endif // #ifndef __FRAMEWORK_ARGUMENTS_H_
174