include/sfx2/sidebar/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_SFX2_SIDEBAR_ENUMCONTEXT_HXX
  20 #define INCLUDED_SFX2_SIDEBAR_ENUMCONTEXT_HXX
  21
  22 #include <sfx2/dllapi.h>
  23
  24 #include <rtl/ustring.hxx>
  25
  26 #include <vector>
  27
  28
  29 namespace sfx2 { namespace sidebar {
  30
  31 class SFX2_DLLPUBLIC EnumContext
  32 {
  33 public:
  34     enum Application
  35     {
  36         Application_Writer,
  37         Application_WriterGlobal,
  38         Application_WriterWeb,
  39         Application_WriterXML,
  40         Application_WriterForm,
  41         Application_WriterReport,
  42         Application_Calc,
  43         Application_Draw,
  44         Application_Impress,
  45
  46         // For your convenience to avoid duplicate code in the common
  47         // case that Draw and Impress use identical context configurations.
  48         Application_DrawImpress,
  49
  50         // Also for your convenience for the different variants of Writer documents.
  51         Application_WriterVariants,
  52
  53         // Used only by deck or panel descriptors.  Matches any
  54         // application.
  55         Application_Any,
  56
  57         // Use this only in special circumstances.  One might be the
  58         // wish to disable a deck or panel during debugging.
  59         Application_None,
  60
  61         __LastApplicationEnum = Application_None
  62     };
  63     enum Context
  64     {
  65         Context_3DObject,
  66         Context_Annotation,
  67         Context_Auditing,
  68         Context_Cell,
  69         Context_Chart,
  70         Context_Draw,
  71         Context_DrawPage,
  72         Context_DrawText,
  73         Context_EditCell,
  74         Context_Form,
  75         Context_Frame,
  76         Context_Graphic,
  77         Context_HandoutPage,
  78         Context_MasterPage,
  79         Context_Media,
  80         Context_MultiObject,
  81         Context_NotesPage,
  82         Context_OLE,
  83         Context_OutlineText,
  84         Context_Pivot,
  85         Context_SlidesorterPage,
  86         Context_Table,
  87         Context_Text,
  88         Context_TextObject,
  89
  90         // Default context of an application.  Do we need this?
  91         Context_Default,
  92
  93         // Used only by deck or panel descriptors.  Matches any context.
  94         Context_Any,
  95
  96         // Special context name that is only used when a deck would
  97         // otherwise be empty.
  98         Context_Empty,
  99
 100         Context_Unknown,
 101
 102         __LastContextEnum = Context_Unknown
 103     };
 104
 105     EnumContext (void);
 106     EnumContext (
 107         const Application eApplication,
 108         const Context eContext);
 109     EnumContext (
 110         const ::rtl::OUString& rsApplicationName,
 111         const ::rtl::OUString& rsContextName);
 112
 113     /** This variant of the GetCombinedContext() method treats some
 114         application names as identical to each other.  Replacements
 115         made are:
 116             Draw or Impress     -> DrawImpress
 117             Writer or WriterWeb -> WriterAndWeb
 118         Use the Application_DrawImpress or Application_WriterAndWeb values in the CombinedEnumContext macro.
 119     */
 120     sal_Int32 GetCombinedContext_DI(void) const;
 121
 122     const ::rtl::OUString& GetApplicationName (void) const;
 123     Application GetApplication_DI (void) const;
 124
 125     const ::rtl::OUString& GetContextName (void) const;
 126     Context GetContext (void) const;
 127
 128     bool operator == (const EnumContext aOther);
 129     bool operator != (const EnumContext aOther);
 130
 131     /** When two contexts are matched against each other then
 132         application or context name may have the wildcard value 'any'.
 133         In order to prefer matches without wildcards over matches with
 134         wildcards we introduce a integer evaluation for matches.
 135     */
 136     const static sal_Int32 NoMatch;
 137     const static sal_Int32 OptimalMatch;
 138
 139     /** Return the numeric value that describes how good the match
 140         between two contexts is.
 141         Smaller values represent better matches.
 142     */
 143     sal_Int32 EvaluateMatch (const EnumContext& rOther) const;
 144
 145     /** Return the best match against the given list of contexts.
 146     */
 147     sal_Int32 EvaluateMatch (const ::std::vector<EnumContext>& rOthers) const;
 148
 149     static Application GetApplicationEnum (const ::rtl::OUString& rsApplicationName);
 150     static const ::rtl::OUString& GetApplicationName (const Application eApplication);
 151
 152     static Context GetContextEnum (const ::rtl::OUString& rsContextName);
 153     static const ::rtl::OUString& GetContextName (const Context eContext);
 154
 155 private:
 156     Application meApplication;
 157     Context meContext;
 158
 159     static void ProvideApplicationContainers (void);
 160     static void ProvideContextContainers (void);
 161     static void AddEntry (const ::rtl::OUString& rsName, const Application eApplication);
 162     static void AddEntry (const ::rtl::OUString& rsName, const Context eContext);
 163 };
 164
 165
 166 #define CombinedEnumContext(a,e) ((static_cast<sal_uInt16>(::sfx2::sidebar::EnumContext::a)<<16)\
 167         | static_cast<sal_uInt16>(::sfx2::sidebar::EnumContext::e))
 168
 169 } } // end of namespace sfx2::sidebar
 170
 171 #endif
 172
 173 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */