icon_set.h
1 /*
2 ** UICore
3 ** Copyright (c) 1997-2015 The UICore 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 UICore may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28 
29 #pragma once
30 
31 #include <memory>
32 #include "../../Core/System/databuffer.h"
33 
34 namespace uicore
35 {
36  class PixelBuffer;
37  typedef std::shared_ptr<PixelBuffer> PixelBufferPtr;
38 
40  class IconSet
41  {
42  public:
44  static std::shared_ptr<IconSet> create();
45 
47  virtual const std::vector<PixelBufferPtr> &images() const = 0;
48 
50  virtual void add_image(const PixelBufferPtr &image) = 0;
51 
53  virtual DataBufferPtr create_win32_icon() = 0;
54  };
55 
56  typedef std::shared_ptr<IconSet> IconSetPtr;
57 }
std::shared_ptr< IconSet > IconSetPtr
Definition: icon_set.h:56
Icon set class.
Definition: icon_set.h:40
virtual void add_image(const PixelBufferPtr &image)=0
Adds an image to the icon set.
virtual DataBufferPtr create_win32_icon()=0
Generates a Windows .ICO format icon from the set.
static std::shared_ptr< IconSet > create()
Constructs an icon set.
std::shared_ptr< PixelBuffer > PixelBufferPtr
Definition: d3d_target.h:39
std::shared_ptr< DataBuffer > DataBufferPtr
Definition: databuffer.h:66
virtual const std::vector< PixelBufferPtr > & images() const =0
Returns all the images in the icon set.
Definition: Application/application.h:35