listview_selected_item.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Harry Storbacka
27 */
28 
29 
30 #pragma once
31 
32 #include "../api_gui.h"
33 #include "listview_item.h"
34 
35 namespace clan
36 {
39 
40 class ListViewSelectedItem_Impl;
41 class ListViewSelection_Impl;
42 
44 class CL_API_GUI ListViewSelectedItem
45 {
48 
49 public:
52 
57 
61 
62 public:
63 
65  bool is_null() const { return !impl; }
66 
68  void throw_if_null() const;
69 
73  bool is_item() const;
74 
78  ListViewItem get_item();
79 
83  ListViewSelectedItem prev();
84 
88  ListViewSelectedItem get_next_sibling();
89 
93 
94 public:
95 
99 
100 private:
101 
105  ListViewSelectedItem(const std::shared_ptr<ListViewSelectedItem_Impl> &impl);
106 
107  std::shared_ptr<ListViewSelectedItem_Impl> impl;
108 
109  friend class ListViewSelection;
111 };
112 
114 class CL_API_GUI ListViewSelection
115 {
118 
119 public:
121 
125 
126 public:
127 
131  ListViewSelectedItem get_first();
132 
136  ListViewSelectedItem get_last();
137 
141 
142 public:
143 
147  void append(const ListViewItem &item);
148 
152  void remove(const ListViewItem &item);
153 
155  void clear();
156 
160 
161 private:
162  std::shared_ptr<ListViewSelection_Impl> impl;
164 };
165 
166 }
167 
ListView selection.
Definition: listview_selected_item.h:114
ListView item.
Definition: listview_item.h:50
bool is_null() const
Returns true if this object is invalid.
Definition: listview_selected_item.h:65
ListView selected item.
Definition: listview_selected_item.h:44