include/vcl/EnumContext.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 INCLUDED_VCL_ENUMCONTEXT_HXX
  20 #define INCLUDED_VCL_ENUMCONTEXT_HXX
  21
  22 #include <vcl/dllapi.h>
  23
  24 #include <rtl/ustring.hxx>
  25
  26
  27 namespace vcl {
  28
  29 class VCL_DLLPUBLIC EnumContext
  30 {
  31 public:
  32     enum class Application
  33     {
  34         Writer,
  35         WriterGlobal,
  36         WriterWeb,
  37         WriterXML,
  38         WriterForm,
  39         WriterReport,
  40         Calc,
  41         Chart,
  42         Draw,
  43         Impress,
  44         Formula,
  45         Base,
  46
  47         // For your convenience to avoid duplicate code in the common
  48         // case that Draw and Impress use identical context configurations.
  49         DrawImpress,
  50
  51         // Also for your convenience for the different variants of Writer documents.
  52         WriterVariants,
  53
  54         // Used only by deck or panel descriptors.  Matches any
  55         // application.
  56         Any,
  57
  58         // Use this only in special circumstances.  One might be the
  59         // wish to disable a deck or panel during debugging.
  60         NONE,
  61
  62         LAST = Application::NONE
  63     };
  64     enum class Context
  65     {
  66         ThreeDObject,
  67         Annotation,
  68         Auditing,
  69         Axis,
  70         Cell,
  71         Chart,
  72         ChartElements,
  73         Draw,
  74         DrawLine,
  75         DrawPage,
  76         DrawText,
  77         EditCell,
  78         ErrorBar,
  79         Form,
  80         Frame,
  81         Graphic,
  82         Grid,
  83         HandoutPage,
  84         MasterPage,
  85         Media,
  86         MultiObject,
  87         NotesPage,
  88         OLE,
  89         OutlineText,
  90         Pivot,
  91         Printpreview,
  92         Series,
  93         SlidesorterPage,
  94         Table,
  95         Text,
  96         TextObject,
  97         Trendline,
  98
  99         // Default context of an application.  Do we need this?
 100         Default,
 101
 102         // Used only by deck or panel descriptors.  Matches any context.
 103         Any,
 104
 105         // Special context name that is only used when a deck would
 106         // otherwise be empty.
 107         Empty,
 108
 109         Unknown,
 110
 111         LAST = Unknown
 112     };
 113
 114     EnumContext();
 115     EnumContext (
 116         const Application eApplication,
 117         const Context eContext);
 118
 119     /** This variant of the GetCombinedContext() method treats some
 120         application names as identical to each other.  Replacements
 121         made are:
 122             Draw or Impress     -> DrawImpress
 123             Writer or WriterWeb -> WriterAndWeb
 124         Use the Application::DrawImpress or Application::WriterAndWeb values in the CombinedEnumContext macro.
 125     */
 126     sal_Int32 GetCombinedContext_DI() const;
 127
 128     Application GetApplication_DI() const;
 129
 130     bool operator == (const EnumContext& rOther);
 131     bool operator != (const EnumContext& rOther);
 132
 133     /** When two contexts are matched against each other, then
 134         application or context name may have the wildcard value 'any'.
 135         In order to prefer matches without wildcards over matches with
 136         wildcards we introduce an integer evaluation for matches.
 137     */
 138     const static sal_Int32 NoMatch;
 139     const static sal_Int32 OptimalMatch;
 140
 141     static Application GetApplicationEnum (const OUString& rsApplicationName);
 142     static const OUString& GetApplicationName (const Application eApplication);
 143
 144     static Context GetContextEnum (const OUString& rsContextName);
 145     static const OUString& GetContextName (const Context eContext);
 146
 147 private:
 148     Application meApplication;
 149     Context meContext;
 150
 151     static void ProvideApplicationContainers();
 152     static void ProvideContextContainers();
 153     static void AddEntry (const OUString& rsName, const Application eApplication);
 154     static void AddEntry (const OUString& rsName, const Context eContext);
 155 };
 156
 157
 158 #define CombinedEnumContext(a,e) ((static_cast<sal_uInt16>(::vcl::EnumContext::a)<<16)\
 159         | static_cast<sal_uInt16>(::vcl::EnumContext::e))
 160
 161 } // end of namespace vcl
 162
 163 #endif
 164
 165 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */