ClanLib  2.3.7
frame.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 ** Magnus Norddahl
27 ** Harry Storbacka
28 */
29 
32 
33 #pragma once
34 
35 #include "../api_gui.h"
36 #include "../gui_component.h"
37 
38 class CL_Sprite;
39 class CL_Frame_Impl;
40 
45 {
48 
49 public:
50 
54  CL_Frame(CL_GUIComponent *parent);
55 
56  virtual ~CL_Frame();
57 
61 
62 public:
64 
68  static CL_Frame *get_named_item(CL_GUIComponent *reference_component, const CL_StringRef &id);
69 
73  CL_Sprite get_header_icon() const;
74 
78  CL_StringRef get_header_text() const;
79 
83 
84 public:
85 
89  void set_header_icon(const CL_Sprite &icon);
90 
94  void set_header_text(const CL_StringRef &text);
95 
99 
100 private:
101  CL_SharedPtr<CL_Frame_Impl> impl;
103 };
104