Unity Scopes API
SwitchFilter.h
1 /*
2  * Copyright (C) 2014 Canonical Ltd
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License version 3 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Pawel Stolowski <pawel.stolowski@canonical.com>
17  */
18 
19 #pragma once
20 
21 #include <unity/scopes/FilterBase.h>
22 
23 namespace unity
24 {
25 
26 namespace scopes
27 {
28 
29 class FilterState;
30 
31 namespace internal
32 {
33 class SwitchFilterImpl;
34 }
35 
36 namespace experimental
37 {
38 
44 class UNITY_API SwitchFilter : public FilterBase
45 {
46 public:
48  UNITY_DEFINES_PTRS(SwitchFilter);
50 
57  static SwitchFilter::UPtr create(std::string const& id, std::string const& label);
58 
63  std::string label() const;
64 
73  bool is_on(FilterState const& filter_state) const;
74 
81  void update_state(FilterState& filter_state, bool active) const;
82 
89  static void update_state(FilterState& filter_state, std::string const& filter_id, bool active);
90 
91 private:
92  SwitchFilter(internal::SwitchFilterImpl*);
93  internal::SwitchFilterImpl* fwd() const;
94  friend class internal::SwitchFilterImpl;
95 };
96 
97 } // namespace experimental
98 
99 } // namespace scopes
100 
101 } // namespace unity
Top-level namespace for all things Unity-related.
Definition: Version.h:49
Definition: ActionMetadata.h:31