filter/source/config/cache/constant.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef _FILTER_CONFIG_CONSTANT_HXX_
  20 #define _FILTER_CONFIG_CONSTANT_HXX_
  21
  22 #include "macros.hxx"
  23
  24 /*  disable impl_loadOnDemand function of BaseContainer for certain
  25     functions, where it the feature "impl_loadItemOnDemand() of class FilterCache
  26     can be used instead of loadAll()!*/
  27 // #define LOAD_IMPLICIT
  28
  29 //_______________________________________________
  30
  31 /** @short  used to identify a some generic item properties against the
  32             configuration API and can be used at all name containers
  33             (based on this filtercache) too.
  34  */
  35 #define  PROPNAME_NAME  "Name"
  36
  37 /** @short  used to identify a type item property against the
  38             configuration API and can be used at all name containers
  39             (based on this filtercache) too.
  40  */
  41 #define  PROPNAME_UINAME            "UIName"
  42 #define  PROPNAME_UINAMES           "UINames"
  43 #define  PROPNAME_PREFERRED         "Preferred"
  44 #define  PROPNAME_PREFERREDFILTER   "PreferredFilter"
  45 #define  PROPNAME_DETECTSERVICE     "DetectService"
  46 #define  PROPNAME_MEDIATYPE         "MediaType"
  47 #define  PROPNAME_CLIPBOARDFORMAT   "ClipboardFormat"
  48 #define  PROPNAME_URLPATTERN        "URLPattern"
  49 #define  PROPNAME_EXTENSIONS        "Extensions"
  50
  51 /** @short  used to identify a filter item property against the
  52             configuration API and can be used at all name containers
  53             (based on this filtercache) too.
  54  */
  55 #define  PROPNAME_TYPE              "Type"
  56 #define  PROPNAME_DOCUMENTSERVICE   "DocumentService"
  57 #define  PROPNAME_FILTERSERVICE     "FilterService"
  58 #define  PROPNAME_UICOMPONENT       "UIComponent"
  59 #define  PROPNAME_FLAGS             "Flags"
  60 #define  PROPNAME_USERDATA          "UserData"
  61 #define  PROPNAME_TEMPLATENAME      "TemplateName"
  62 #define  PROPNAME_FILEFORMATVERSION "FileFormatVersion"
  63 #define  PROPNAME_EXPORTEXTENSION   "ExportExtension"
  64
  65 /** @short  used to identify a frame loader or detect service item
  66             property against the configuration API and can be used
  67             at all name containers (based on this filtercache) too.
  68  */
  69 #define  PROPNAME_TYPES     "Types"
  70
  71 /** @short  used to identify the list of sorted filters for a specific
  72             office module
  73  */
  74 #define  PROPNAME_SORTEDFILTERLIST     _FILTER_CONFIG_FROM_ASCII_("SortedFilterList")
  75
  76 /** @short  implicit properties. which are used at the container interface only.
  77  */
  78 #define  PROPNAME_FINALIZED _FILTER_CONFIG_FROM_ASCII_("Finalized")
  79 #define  PROPNAME_MANDATORY _FILTER_CONFIG_FROM_ASCII_("Mandatory")
  80
  81 /** @short  used to identify a set of items against the configuration API. */
  82 #define  CFGSET_TYPES               _FILTER_CONFIG_FROM_ASCII_("Types"          )
  83 #define  CFGSET_FILTERS             _FILTER_CONFIG_FROM_ASCII_("Filters"        )
  84 #define  CFGSET_FRAMELOADERS        _FILTER_CONFIG_FROM_ASCII_("FrameLoaders"   )
  85 #define  CFGSET_CONTENTHANDLERS     _FILTER_CONFIG_FROM_ASCII_("ContentHandlers")
  86
  87 /** @short  used to address some configuration keys directly.
  88
  89     @descr  Such direct keys should be used with function
  90             FilterCache::impl_getDirectCFGValue() only!
  91
  92     @TODO   define these direct keys ...
  93  */
  94 #define  CFGDIRECTKEY_OFFICELOCALE          _FILTER_CONFIG_FROM_ASCII_("/org.openoffice.Setup/L10N/ooLocale"                           )
  95 #define  CFGDIRECTKEY_DEFAULTFRAMELOADER    _FILTER_CONFIG_FROM_ASCII_("/org.openoffice.TypeDetection.Misc/Defaults/DefaultFrameLoader")
  96 #define  CFGDIRECTKEY_OFFICELOCALE          _FILTER_CONFIG_FROM_ASCII_("/org.openoffice.Setup/L10N/ooLocale"                           )
  97 #define  CFGDIRECTKEY_FORMATNAME            _FILTER_CONFIG_FROM_ASCII_("/org.openoffice.Setup/Product/ooXMLFileFormatName"             )
  98 #define  CFGDIRECTKEY_FORMATVERSION         _FILTER_CONFIG_FROM_ASCII_("/org.openoffice.Setup/Product/ooXMLFileFormatVersion"          )
  99 #define  CFGDIRECTKEY_PRODUCTNAME           _FILTER_CONFIG_FROM_ASCII_("/org.openoffice.Setup/Product/ooName"                          )
 100
 101 // Note that these flag bits have parallel names in
 102 // comphelper/inc/comphelper/documentconstants.hxx . See that file for
 103 // documentation on their meaning.
 104
 105 /** @short  names of filter flags, sorted in alphabetical order */
 106 #define  FLAGNAME_3RDPARTYFILTER    _FILTER_CONFIG_FROM_ASCII_("3RDPARTYFILTER"   )
 107 #define  FLAGNAME_ALIEN             _FILTER_CONFIG_FROM_ASCII_("ALIEN"            )
 108 #define  FLAGNAME_ASYNCHRON         _FILTER_CONFIG_FROM_ASCII_("ASYNCHRON"        )
 109 #define  FLAGNAME_BROWSERPREFERRED  _FILTER_CONFIG_FROM_ASCII_("BROWSERPREFERRED" )
 110 #define  FLAGNAME_CONSULTSERVICE    _FILTER_CONFIG_FROM_ASCII_("CONSULTSERVICE"   )
 111 #define  FLAGNAME_DEFAULT           _FILTER_CONFIG_FROM_ASCII_("DEFAULT"          )
 112 #define  FLAGNAME_ENCRYPTION        _FILTER_CONFIG_FROM_ASCII_("ENCRYPTION"       )
 113 #define  FLAGNAME_EXPORT            _FILTER_CONFIG_FROM_ASCII_("EXPORT"           )
 114 #define  FLAGNAME_IMPORT            _FILTER_CONFIG_FROM_ASCII_("IMPORT"           )
 115 #define  FLAGNAME_INTERNAL          _FILTER_CONFIG_FROM_ASCII_("INTERNAL"         )
 116 #define  FLAGNAME_NOTINCHOOSER      _FILTER_CONFIG_FROM_ASCII_("NOTINCHOOSER"     )
 117 #define  FLAGNAME_NOTINFILEDIALOG   _FILTER_CONFIG_FROM_ASCII_("NOTINFILEDIALOG"  )
 118 #define  FLAGNAME_NOTINSTALLED      _FILTER_CONFIG_FROM_ASCII_("NOTINSTALLED"     )
 119 #define  FLAGNAME_OWN               _FILTER_CONFIG_FROM_ASCII_("OWN"              )
 120 #define  FLAGNAME_PACKED            _FILTER_CONFIG_FROM_ASCII_("PACKED"           )
 121 #define  FLAGNAME_PASSWORDTOMODIFY  _FILTER_CONFIG_FROM_ASCII_("PASSWORDTOMODIFY" )
 122 #define  FLAGNAME_PREFERRED         _FILTER_CONFIG_FROM_ASCII_("PREFERRED"        )
 123 #define  FLAGNAME_STARTPRESENTATION _FILTER_CONFIG_FROM_ASCII_("STARTPRESENTATION")
 124 #define  FLAGNAME_READONLY          _FILTER_CONFIG_FROM_ASCII_("READONLY"         )
 125 #define  FLAGNAME_SUPPORTSSELECTION _FILTER_CONFIG_FROM_ASCII_("SUPPORTSSELECTION")
 126 #define  FLAGNAME_TEMPLATE          _FILTER_CONFIG_FROM_ASCII_("TEMPLATE"         )
 127 #define  FLAGNAME_TEMPLATEPATH      _FILTER_CONFIG_FROM_ASCII_("TEMPLATEPATH"     )
 128 #define  FLAGNAME_USESOPTIONS       _FILTER_CONFIG_FROM_ASCII_("USESOPTIONS"      )
 129 #define  FLAGNAME_COMBINED          _FILTER_CONFIG_FROM_ASCII_("COMBINED"         )
 130
 131 /** @short  values of filter flags, sorted based on value */
 132 #define  FLAGVAL_IMPORT            0x00000001 // 1
 133 #define  FLAGVAL_EXPORT            0x00000002 // 2
 134 #define  FLAGVAL_TEMPLATE          0x00000004 // 4
 135 #define  FLAGVAL_INTERNAL          0x00000008 // 8
 136 #define  FLAGVAL_TEMPLATEPATH      0x00000010 // 16
 137 #define  FLAGVAL_OWN               0x00000020 // 32
 138 #define  FLAGVAL_ALIEN             0x00000040 // 64
 139 #define  FLAGVAL_USESOPTIONS       0x00000080 // 128
 140 #define  FLAGVAL_DEFAULT           0x00000100 // 256
 141 #define  FLAGVAL_SUPPORTSSELECTION 0x00000400 // 1024
 142 #define  FLAGVAL_NOTINFILEDIALOG   0x00001000 // 4096
 143 #define  FLAGVAL_NOTINCHOOSER      0x00002000 // 8192
 144 #define  FLAGVAL_ASYNCHRON         0x00004000 // 16384
 145 #define  FLAGVAL_READONLY          0x00010000 // 65536
 146 #define  FLAGVAL_NOTINSTALLED      0x00020000 // 131072
 147 #define  FLAGVAL_CONSULTSERVICE    0x00040000 // 262144
 148 #define  FLAGVAL_3RDPARTYFILTER    0x00080000 // 524288
 149 #define  FLAGVAL_PACKED            0x00100000 // 1048576
 150 #define  FLAGVAL_BROWSERPREFERRED  0x00400000 // 4194304
 151 #define  FLAGVAL_COMBINED          0x00800000 // 8388608
 152 #define  FLAGVAL_ENCRYPTION        0x01000000 // 16777216
 153 #define  FLAGVAL_PASSWORDTOMODIFY  0x02000000 // 33554432
 154 #define  FLAGVAL_PREFERRED         0x10000000 // 268435456
 155 #define  FLAGVAL_STARTPRESENTATION 0x20000000 // 268435456
 156 #define  FLAGVAL_ALL               0xffffffff // 4294967295
 157
 158 /** @short  some uno service names.
 159  */
 160 #define  SERVICE_CONFIGURATIONUPDATEACCESS  _FILTER_CONFIG_FROM_ASCII_("com.sun.star.configuration.ConfigurationUpdateAccess" )
 161 #define  SERVICE_CONFIGURATIONACCESS        _FILTER_CONFIG_FROM_ASCII_("com.sun.star.configuration.ConfigurationAccess"       )
 162
 163 /** @short  some configuration paths.
 164  */
 165 #define  CFGPACKAGE_TD_TYPES           _FILTER_CONFIG_FROM_ASCII_("/org.openoffice.TypeDetection.Types" )
 166 #define  CFGPACKAGE_TD_FILTERS         _FILTER_CONFIG_FROM_ASCII_("/org.openoffice.TypeDetection.Filter")
 167 #define  CFGPACKAGE_TD_OTHERS          _FILTER_CONFIG_FROM_ASCII_("/org.openoffice.TypeDetection.Misc"  )
 168 #define  CFGPACKAGE_TD_UISORT          _FILTER_CONFIG_FROM_ASCII_("/org.openoffice.TypeDetection.UISort/ModuleDependendFilterOrder")
 169 #define  CFGPACKAGE_TD_OLD             _FILTER_CONFIG_FROM_ASCII_("/org.openoffice.Office.TypeDetection")
 170 #define  CFGPACKAGE_OOO_MODULES        _FILTER_CONFIG_FROM_ASCII_("/org.openoffice.Setup/Office/Factories")
 171
 172 /** @short  some default values.
 173  */
 174 #define  DEFAULT_OFFICELOCALE       _FILTER_CONFIG_FROM_ASCII_("en-US")
 175 #define  DEFAULT_FORMATNAME         _FILTER_CONFIG_FROM_ASCII_("LibreOffice")
 176 #define  DEFAULT_FORMATVERSION      _FILTER_CONFIG_FROM_ASCII_("1.0")
 177
 178 /** @short  used for the queries of the FilterFactory service.
 179  */
 180 #define  QUERY_IDENTIFIER_MATCHBYDOCUMENTSERVICE    _FILTER_CONFIG_FROM_ASCII_("matchByDocumentService" )
 181 #define  QUERY_IDENTIFIER_GETPREFERREDFILTERFORTYPE _FILTER_CONFIG_FROM_ASCII_("getDefaultFilterForType")
 182 #define  QUERY_IDENTIFIER_GET_SORTED_FILTERLIST     _FILTER_CONFIG_FROM_ASCII_("getSortedFilterList()"  )
 183
 184 #define  QUERY_PARAM_IFLAGS                         _FILTER_CONFIG_FROM_ASCII_("iflags")
 185 #define  QUERY_PARAM_EFLAGS                         _FILTER_CONFIG_FROM_ASCII_("eflags")
 186 #define  QUERY_PARAM_MODULE                         _FILTER_CONFIG_FROM_ASCII_("module")
 187 #define  QUERY_PARAM_DEFAULTFIRST                   _FILTER_CONFIG_FROM_ASCII_("default_first")
 188 #define  QUERY_CONSTVALUE_ALL                       _FILTER_CONFIG_FROM_ASCII_("all")
 189
 190 #endif // _FILTER_CONFIG_CONSTANT_HXX_
 191
 192 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */