xref: /trunk/main/sfx2/source/sidebar/ContextList.hxx (revision da72173f)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 #ifndef SFX_SIDEBAR_CONTEXT_LIST_HXX
23 #define SFX_SIDEBAR_CONTEXT_LIST_HXX
24 
25 #include "Context.hxx"
26 #include <sal/types.h>
27 #include <rtl/ustring.hxx>
28 
29 #include <vector>
30 
31 
32 namespace sfx2 { namespace sidebar {
33 
34 
35 class ContextList
36 {
37 public:
38     ContextList (void);
39     ~ContextList (void);
40 
41     class Entry
42     {
43     public:
44         Context maContext;
45         bool mbIsInitiallyVisible;
46         ::rtl::OUString msMenuCommand;
47     };
48 
49     /** Return <TRUE/> when the given context matches any of the stored contexts.
50     */
51     const Entry* GetMatch (
52         const Context& rContext) const;
53 
54     void AddContextDescription (
55         const Context& rContext,
56         const bool bIsInitiallyVisible,
57         const ::rtl::OUString& rsMenuCommand);
58 
59     /** Returns <TRUE/> when no call to AddContextDescription() was made before.
60     */
61     bool IsEmpty (void);
62 
63 
64 private:
65     ::std::vector<Entry> maEntries;
66 
67     ::std::vector<Entry>::const_iterator FindBestMatch (const Context& rContext) const;
68 };
69 
70 
71 } } // end of namespace sfx2::sidebar
72 
73 #endif
74