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