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