frame.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 **    Magnus Norddahl
00027 **    Harry Storbacka
00028 */
00029 
00032 
00033 #pragma once
00034 
00035 #include "../api_gui.h"
00036 #include "../gui_component.h"
00037 
00038 class CL_Sprite;
00039 class CL_Frame_Impl;
00040 
00044 class CL_API_GUI CL_Frame : public CL_GUIComponent
00045 {
00048 
00049 public:
00050 
00054         CL_Frame(CL_GUIComponent *parent);
00055 
00056         virtual ~CL_Frame();
00057 
00061 
00062 public:
00063         using CL_GUIComponent::get_named_item;
00064 
00068         static CL_Frame *get_named_item(CL_GUIComponent *reference_component, const CL_StringRef &id);
00069 
00073         CL_Sprite get_header_icon() const;
00074 
00078         CL_StringRef get_header_text() const;
00079 
00083 
00084 public:
00085 
00089         void set_header_icon(const CL_Sprite &icon);
00090 
00094         void set_header_text(const CL_StringRef &text);
00095 
00099 
00100 private:
00101         CL_SharedPtr<CL_Frame_Impl> impl;
00103 };
00104