framework/inc/arguments.h

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