Unity Scopes API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
RadioButtonsFilter.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 #ifndef UNITY_SCOPES_RADIOBUTTONSFILTER_H
20 #define UNITY_SCOPES_RADIOBUTTONSFILTER_H
21 
22 #include <unity/scopes/FilterBase.h>
23 #include <unity/scopes/FilterOption.h>
24 
25 namespace unity
26 {
27 
28 namespace scopes
29 {
30 
31 class FilterState;
32 
33 namespace internal
34 {
35 
36 class RadioButtonsFilterImpl;
37 
38 }
39 
40 namespace experimental
41 {
42 
48 class UNITY_API RadioButtonsFilter : public FilterBase
49 {
50 public:
52  UNITY_DEFINES_PTRS(RadioButtonsFilter);
54 
63  static RadioButtonsFilter::UPtr create(std::string const& id, std::string const& label);
64 
72  FilterOption::SCPtr add_option(std::string const& id, std::string const& label);
73 
78  std::string label() const;
79 
84  FilterOption::SCPtr active_option(FilterState const& filter_state) const;
85 
91  bool has_active_option(FilterState const& filter_state) const;
92 
93 
98  std::list<FilterOption::SCPtr> options() const;
99 
107  void update_state(FilterState& filter_state, FilterOption::SCPtr option, bool active) const;
108 
115  static void update_state(FilterState& filter_state, std::string const& filter_id, std::string const& option_id, bool value);
116 
117 private:
118  RadioButtonsFilter(internal::RadioButtonsFilterImpl*);
119  internal::RadioButtonsFilterImpl* fwd() const;
120  friend class internal::RadioButtonsFilterImpl;
121 };
122 
123 } // namespace experimental
124 
125 } // namespace scopes
126 
127 } // namespace unity
128 
129 #endif
Top-level namespace for all things Unity-related.
Definition: Version.h:50
Definition: ActionMetadata.h:32