sfx2/inc/sidebar/ContextList.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 #pragma once
  20
  21 #include <sfx2/sidebar/Context.hxx>
  22 #include <rtl/ustring.hxx>
  23
  24 #include <vector>
  25
  26 namespace sfx2::sidebar {
  27
  28 /** Per context data for deck and panel descriptors.
  29 */
  30 class ContextList
  31 {
  32 public:
  33     ContextList();
  34
  35     class Entry
  36     {
  37     public:
  38         Context maContext;
  39         bool mbIsInitiallyVisible;
  40         OUString msMenuCommand;
  41     };
  42
  43     /** Return <TRUE/> when the given context matches any of the stored contexts.
  44     */
  45     const Entry* GetMatch (
  46         const Context& rContext) const;
  47     Entry* GetMatch (
  48         const Context& rContext);
  49
  50     void AddContextDescription (
  51         const Context& rContext,
  52         const bool bIsInitiallyVisible,
  53         const OUString& rsMenuCommand);
  54
  55     void ToggleVisibilityForContext( const Context& rContext,const bool bIsInitiallyVisible );
  56     const ::std::vector<Entry>& GetEntries() const {return maEntries;};
  57
  58 private:
  59     ::std::vector<Entry> maEntries;
  60
  61     ::std::vector<Entry>::const_iterator FindBestMatch (const Context& rContext) const;
  62 };
  63
  64 } // end of namespace sfx2::sidebar
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */