push_button.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 **    Harry Storbacka
00027 **    Kenneth Gangstoe
00028 **    Magnus Norddahl
00029 */
00030 
00033 
00034 #pragma once
00035 
00036 #include "../api_gui.h"
00037 #include "../gui_component.h"
00038 #include "../../Core/Signals/callback_v0.h"
00039 #include "../../Display/Render/graphic_context.h"
00040 
00041 class CL_Image;
00042 class CL_PushButton_Impl;
00043 
00047 class CL_API_GUI CL_PushButton : public CL_GUIComponent
00048 {
00051 
00052 public:
00053 
00057         CL_PushButton(CL_GUIComponent *parent);
00058 
00059         virtual ~CL_PushButton();
00060 
00064 
00065 public:
00066 
00067         using CL_GUIComponent::get_named_item;
00068 
00072         static CL_PushButton *get_named_item(CL_GUIComponent *reference_component, const CL_StringRef &id);
00073 
00077         bool is_pushed() const;
00078 
00082         bool is_toggle() const;
00083 
00087         bool is_flat() const;
00088 
00092         CL_Image get_icon() const;
00093 
00094         enum IconPosition
00095         {
00096                 icon_left, icon_top, icon_right, icon_bottom
00097         };
00098 
00102         IconPosition get_icon_position() const;
00103 
00104         const CL_String &get_text() const;
00105 
00109         CL_Size get_preferred_size() const;
00110 
00114 
00115 public:
00116 
00120         void set_pushed(bool enable);
00121 
00125         void set_toggle(bool enable);
00126 
00130         void set_flat(bool enable);
00131 
00135         void set_icon(const CL_Image &icon);
00136 
00140         void set_icon_position(IconPosition pos);
00141 
00145         void set_text(const CL_StringRef &text);
00146 
00150 
00151 public:
00152 
00156         CL_Callback_v0 &func_clicked();
00157 
00161 
00162 private:
00163         CL_SharedPtr<CL_PushButton_Impl> impl;
00165 };
00166