Unity Scopes API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
RatingFilter.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_RATINGFILTER_H
20 #define UNITY_SCOPES_RATINGFILTER_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 RatingFilterImpl;
37 
38 }
39 
40 namespace experimental
41 {
42 
53 class UNITY_API RatingFilter : public FilterBase
54 {
55 public:
57  UNITY_DEFINES_PTRS(RatingFilter);
59 
68  static RatingFilter::UPtr create(std::string const& id, std::string const& label);
69 
84  static RatingFilter::UPtr create(std::string const& id, std::string const& label, int top_rating);
85 
93  FilterOption::SCPtr add_option(std::string const& id, std::string const& label);
94 
102  void set_on_icon(std::string const& on_icon);
103 
111  void set_off_icon(std::string const& off_icon);
112 
117  std::string label() const;
118 
126  std::string on_icon() const;
127 
135  std::string off_icon() const;
136 
141  std::list<FilterOption::SCPtr> options() const;
142 
148  bool has_active_rating(FilterState const& filter_state) const;
149 
154  FilterOption::SCPtr active_rating(FilterState const& filter_state) const;
155 
163  void update_state(FilterState& filter_state, FilterOption::SCPtr option, bool active) const;
164 
171  static void update_state(FilterState& filter_state, std::string const& filter_id, std::string const& option_id, bool value);
172 
173 private:
174  RatingFilter(internal::RatingFilterImpl*);
175  internal::RatingFilterImpl* fwd() const;
176  friend class internal::RatingFilterImpl;
177 };
178 
179 } // namespace experimental
180 
181 } // namespace scopes
182 
183 } // namespace unity
184 
185 #endif
Top-level namespace for all things Unity-related.
Definition: Version.h:50
Definition: ActionMetadata.h:32