include/sfx2/sidebar/Context.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_SOURCE_SIDEBAR_CONTEXT_HXX
  20 #define INCLUDED_SFX2_SOURCE_SIDEBAR_CONTEXT_HXX
  21
  22 #include <rtl/ustring.hxx>
  23
  24 namespace sfx2 { namespace sidebar {
  25
  26 class Context
  27 {
  28 public:
  29     OUString msApplication;
  30     OUString msContext;
  31
  32     Context();
  33     Context (
  34         const OUString& rsApplication,
  35         const OUString& rsContext);
  36
  37     /** When two contexts are matched against each other, then
  38         application or context name may have the wildcard value 'any'.
  39         In order to prefer matches without wildcards over matches with
  40         wildcards we introduce an integer evaluation for matches.
  41     */
  42     const static sal_Int32 NoMatch;
  43     const static sal_Int32 OptimalMatch;
  44     const static sal_Int32 ApplicationWildcardMatch;
  45     const static sal_Int32 ContextWildcardMatch;
  46
  47     /** Return the numeric value that describes how good the match
  48         between two contexts is.
  49         Smaller values represent better matches.
  50     */
  51     sal_Int32 EvaluateMatch (const Context& rOther) const;
  52
  53     bool operator== (const Context& rOther) const;
  54     bool operator!= (const Context& rOther) const;
  55 };
  56
  57 } } // end of namespace sfx2::sidebar
  58
  59 #endif
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */