listview_icon.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 "../../Display/2D/sprite.h"
00036 
00037 #include "listview.h"   // Required for the "enum CL_ListViewDisplayMode", as gcc does not like the incomplete type: "enum CL_ListViewDisplayMode;"
00038 
00039 class CL_ListViewIconList_Impl;
00040 class CL_ListViewIcon_Impl;
00041 
00045 class CL_API_GUI CL_ListViewIcon
00046 {
00049 
00050 public:
00051         CL_ListViewIcon();
00052 
00053         ~CL_ListViewIcon();
00054 
00058 
00059 public:
00060 
00066         CL_Sprite get_sprite(CL_ListViewDisplayMode mode);
00067 
00073         CL_PixelBuffer get_pixel_buffer(CL_ListViewDisplayMode mode);
00074 
00080         CL_Point get_offset(CL_ListViewDisplayMode mode);
00081 
00085         bool is_scalable() const;
00086 
00090 
00091 public:
00092 
00097         void set_sprite(const CL_Sprite &sprite, CL_ListViewDisplayMode mode);
00098 
00099         // Offset the drawing position of the icon. Use for positioning overlay icons.
00100         void set_offset(const CL_Point &offset, CL_ListViewDisplayMode mode);
00101 
00106         void set_pixel_buffer(CL_PixelBuffer &pbuf, CL_ListViewDisplayMode mode);
00107 
00114         void draw(CL_GraphicContext &gc, const CL_Rect &rect, CL_ListViewDisplayMode mode, const CL_Colorf &color);
00115 
00119         void set_scalable(bool value);
00120 
00124 
00125 private:
00126         CL_SharedPtr<CL_ListViewIcon_Impl> impl;
00128 };
00129