listview_selected_item.h

Go to the documentation of this file.
00001 /*
00002 **  ClanLib SDK
00003 **  Copyright (c) 1997-2011 The ClanLib Team
00004 **
00005 **  This software is provided 'as-is', without any express or implied
00006 **  warranty.  In no event will the authors be held liable for any damages
00007 **  arising from the use of this software.
00008 **
00009 **  Permission is granted to anyone to use this software for any purpose,
00010 **  including commercial applications, and to alter it and redistribute it
00011 **  freely, subject to the following restrictions:
00012 **
00013 **  1. The origin of this software must not be misrepresented; you must not
00014 **     claim that you wrote the original software. If you use this software
00015 **     in a product, an acknowledgment in the product documentation would be
00016 **     appreciated but is not required.
00017 **  2. Altered source versions must be plainly marked as such, and must not be
00018 **     misrepresented as being the original software.
00019 **  3. This notice may not be removed or altered from any source distribution.
00020 **
00021 **  Note: Some of the libraries ClanLib may link to may have additional
00022 **  requirements or restrictions.
00023 **
00024 **  File Author(s):
00025 **
00026 **    Harry Storbacka
00027 */
00028 
00031 
00032 #pragma once
00033 
00034 #include "../api_gui.h"
00035 #include "listview_item.h"
00036 
00037 class CL_ListViewSelectedItem_Impl;
00038 class CL_ListViewSelection_Impl;
00039 
00043 class CL_API_GUI CL_ListViewSelectedItem
00044 {
00047 
00048 public:
00050         CL_ListViewSelectedItem();
00051 
00055         CL_ListViewSelectedItem(const CL_ListViewItem &item);
00056 
00060 
00061 public:
00062 
00064         bool is_null() const { return !impl; }
00065 
00067         void throw_if_null() const;
00068 
00072         bool is_item() const;
00073 
00077         CL_ListViewItem get_item();
00078 
00082         CL_ListViewSelectedItem prev();
00083 
00087         CL_ListViewSelectedItem get_next_sibling();
00088 
00092 
00093 public:
00094 
00098 
00099 private:
00100 
00104         CL_ListViewSelectedItem(const CL_SharedPtr<CL_ListViewSelectedItem_Impl> &impl);
00105 
00106         CL_SharedPtr<CL_ListViewSelectedItem_Impl> impl;
00107 
00108         friend class CL_ListViewSelection;
00110 };
00111 
00115 class CL_API_GUI CL_ListViewSelection
00116 {
00119 
00120 public:
00121         CL_ListViewSelection();
00122 
00126 
00127 public:
00128 
00132         CL_ListViewSelectedItem get_first();
00133 
00137         CL_ListViewSelectedItem get_last();
00138 
00142 
00143 public:
00144 
00148         void append(const CL_ListViewItem &item);
00149 
00153         void remove(const CL_ListViewItem &item);
00154 
00156         void clear();
00157 
00161 
00162 private:
00163         CL_SharedPtr<CL_ListViewSelection_Impl> impl;
00165 };
00166