ClanLib  2.3.7
listview_icon.h
Go to the documentation of this file.
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2011 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 
31 
32 #pragma once
33 
34 #include "../api_gui.h"
35 #include "../../Display/2D/sprite.h"
36 
37 #include "listview.h" // Required for the "enum CL_ListViewDisplayMode", as gcc does not like the incomplete type: "enum CL_ListViewDisplayMode;"
38 
39 class CL_ListViewIconList_Impl;
40 class CL_ListViewIcon_Impl;
41 
46 {
49 
50 public:
52 
53  ~CL_ListViewIcon();
54 
58 
59 public:
60 
66  CL_Sprite get_sprite(CL_ListViewDisplayMode mode);
67 
73  CL_PixelBuffer get_pixel_buffer(CL_ListViewDisplayMode mode);
74 
80  CL_Point get_offset(CL_ListViewDisplayMode mode);
81 
85  bool is_scalable() const;
86 
90 
91 public:
92 
97  void set_sprite(const CL_Sprite &sprite, CL_ListViewDisplayMode mode);
98 
99  // Offset the drawing position of the icon. Use for positioning overlay icons.
100  void set_offset(const CL_Point &offset, CL_ListViewDisplayMode mode);
101 
106  void set_pixel_buffer(CL_PixelBuffer &pbuf, CL_ListViewDisplayMode mode);
107 
114  void draw(CL_GraphicContext &gc, const CL_Rect &rect, CL_ListViewDisplayMode mode, const CL_Colorf &color);
115 
119  void set_scalable(bool value);
120 
124 
125 private:
126  CL_SharedPtr<CL_ListViewIcon_Impl> impl;
128 };
129