xref: /aoo4110/main/sfx2/source/sidebar/Context.hxx (revision b1cdbd2c)
1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski #ifndef SFX_SIDEBAR_CONTEXT_HXX
23*b1cdbd2cSJim Jagielski #define SFX_SIDEBAR_CONTEXT_HXX
24*b1cdbd2cSJim Jagielski 
25*b1cdbd2cSJim Jagielski #include "rtl/ustring.hxx"
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski #include <vector>
28*b1cdbd2cSJim Jagielski 
29*b1cdbd2cSJim Jagielski namespace sfx2 { namespace sidebar {
30*b1cdbd2cSJim Jagielski 
31*b1cdbd2cSJim Jagielski class Context
32*b1cdbd2cSJim Jagielski {
33*b1cdbd2cSJim Jagielski public:
34*b1cdbd2cSJim Jagielski     ::rtl::OUString msApplication;
35*b1cdbd2cSJim Jagielski     ::rtl::OUString msContext;
36*b1cdbd2cSJim Jagielski 
37*b1cdbd2cSJim Jagielski     Context (void);
38*b1cdbd2cSJim Jagielski     Context (
39*b1cdbd2cSJim Jagielski         const ::rtl::OUString& rsApplication,
40*b1cdbd2cSJim Jagielski         const ::rtl::OUString& rsContext);
41*b1cdbd2cSJim Jagielski 
42*b1cdbd2cSJim Jagielski     /** When two contexts are matched against each other then
43*b1cdbd2cSJim Jagielski         application or context name may have the wildcard value 'any'.
44*b1cdbd2cSJim Jagielski         In order to prefer matches without wildcards over matches with
45*b1cdbd2cSJim Jagielski         wildcards we introduce a integer evaluation for matches.
46*b1cdbd2cSJim Jagielski     */
47*b1cdbd2cSJim Jagielski     const static sal_Int32 NoMatch;
48*b1cdbd2cSJim Jagielski     const static sal_Int32 OptimalMatch;
49*b1cdbd2cSJim Jagielski     const static sal_Int32 ApplicationWildcardMatch;
50*b1cdbd2cSJim Jagielski     const static sal_Int32 ContextWildcardMatch;
51*b1cdbd2cSJim Jagielski 
52*b1cdbd2cSJim Jagielski     /** Return the numeric value that describes how good the match
53*b1cdbd2cSJim Jagielski         between two contexts is.
54*b1cdbd2cSJim Jagielski         Smaller values represent better matches.
55*b1cdbd2cSJim Jagielski     */
56*b1cdbd2cSJim Jagielski     sal_Int32 EvaluateMatch (const Context& rOther) const;
57*b1cdbd2cSJim Jagielski 
58*b1cdbd2cSJim Jagielski     /** Return the best match against the given list of contexts.
59*b1cdbd2cSJim Jagielski     */
60*b1cdbd2cSJim Jagielski     sal_Int32 EvaluateMatch (const ::std::vector<Context>& rOthers) const;
61*b1cdbd2cSJim Jagielski 
62*b1cdbd2cSJim Jagielski     bool operator== (const Context& rOther) const;
63*b1cdbd2cSJim Jagielski     bool operator!= (const Context& rOther) const;
64*b1cdbd2cSJim Jagielski };
65*b1cdbd2cSJim Jagielski 
66*b1cdbd2cSJim Jagielski 
67*b1cdbd2cSJim Jagielski } } // end of namespace sfx2::sidebar
68*b1cdbd2cSJim Jagielski 
69*b1cdbd2cSJim Jagielski #endif
70