listview_icon.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 "../../Display/2D/sprite.h"
34 
35 #include "listview.h" // Required for the "enum ListViewDisplayMode", as gcc does not like the incomplete type: "enum ListViewDisplayMode;"
36 
37 namespace clan
38 {
41 
42 class ListViewIconList_Impl;
43 class ListViewIcon_Impl;
44 
46 class CL_API_GUI ListViewIcon
47 {
50 
51 public:
52  ListViewIcon();
53 
54  ~ListViewIcon();
55 
59 
60 public:
61 
67  Sprite get_sprite(ListViewDisplayMode mode);
68 
74  PixelBuffer get_pixel_buffer(ListViewDisplayMode mode);
75 
81  Point get_offset(ListViewDisplayMode mode);
82 
86  bool is_scalable() const;
87 
91 
92 public:
93 
98  void set_sprite(const Sprite &sprite, ListViewDisplayMode mode);
99 
100  // Offset the drawing position of the icon. Use for positioning overlay icons.
101  void set_offset(const Point &offset, ListViewDisplayMode mode);
102 
107  void set_pixel_buffer(PixelBuffer &pbuf, ListViewDisplayMode mode);
108 
115  void draw(Canvas &canvas, const Rect &rect, ListViewDisplayMode mode, const Colorf &color);
116 
120  void set_scalable(bool value);
121 
125 
126 private:
127  std::shared_ptr<ListViewIcon_Impl> impl;
129 };
130 
131 }
132 
ListView icon.
Definition: listview_icon.h:46
Floating point color description class (for float).
Definition: color.h:661
2D Graphics Canvas
Definition: canvas.h:70
Pixel data container.
Definition: pixel_buffer.h:69
Sprite class.
Definition: sprite.h:57
2D (left,top,right,bottom) rectangle structure - Integer
Definition: rect.h:453
ListViewDisplayMode
Definition: listview.h:36
2D (x,y) point structure - Integer
Definition: point.h:63