label.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 #include "../../Core/Signals/callback_v0.h"
00038 
00039 class CL_SpanLayout;
00040 class CL_Label_Impl;
00041 
00045 class CL_API_GUI CL_Label : public CL_GUIComponent
00046 {
00049 
00050 public:
00051 
00055         CL_Label(CL_GUIComponent *parent);
00056 
00057         virtual ~CL_Label();
00058 
00062 
00063 public:
00064         enum Alignment
00065         {
00066                 align_left,
00067                 align_center,
00068                 align_right,
00069                 align_justify
00070         };
00071 
00072         using CL_GUIComponent::get_named_item;
00073 
00077         static CL_Label *get_named_item(CL_GUIComponent *reference_component, const CL_StringRef &id);
00078 
00082         Alignment get_alignment() const;
00083 
00087         CL_String get_text() const;
00088 
00092         CL_Size get_preferred_size() const;
00093 
00097 
00098 public:
00099 
00103         void set_text(const CL_StringRef &text);
00104 
00108         void set_span(const CL_SpanLayout &layout);
00109 
00113         void set_alignment(Alignment alignment);
00114 
00118 
00119 public:
00120 
00124 
00125 private:
00126         CL_SharedPtr<CL_Label_Impl> impl;
00128 };
00129