Maeomm Reference Documentation: hildonsmm
Main Page   Namespaces   Book  

Hildon::Caption Class Reference
[Widgets]

Inheritance diagram for Hildon::Caption:

Gtk::EventBox Gtk::Bin Gtk::Container Gtk::Widget Gtk::Object Atk::Implementor Glib::Object Glib::Interface Glib::ObjectBase Glib::ObjectBase sigc::trackable sigc::trackable List of all members.

Detailed Description

Hildon::Caption is a single-child container widget that precedes the contained widget with a field label and an optional icon, allowing grouping of several controls together.

When a captioned widget has focus, both the widget and the caption label are displayed with active focus.


Public Member Functions

 Caption (const Glib::ustring& value, Gtk::Widget& child, CaptionStatus flag=CAPTION_OPTIONAL)
 Caption (const Glib::ustring& value, Gtk::Widget& child, Gtk::Widget& icon, CaptionStatus flag=CAPTION_OPTIONAL)
 Caption (const Glib::RefPtr<Gtk::SizeGroup>& group, const Glib::ustring& value, Gtk::Widget& child, Gtk::Widget& icon, CaptionStatus flag=CAPTION_OPTIONAL)
bool get_child_expand () const
 Gets childs expandability.
const Gtk::Widgetget_icon_image () const
 Gets icon of Hildon::Caption.
Gtk::Widgetget_icon_image ()
 Gets icon of Hildon::Caption.
CaptionIconPosition get_icon_position () const
Glib::ustring get_label () const
 Gets label of Hildon::Caption.
float get_label_alignment () const
 Gets current vertical alignment for the text part.
Glib::ustring get_separator () const
 Gets separator string of Hildon::Caption.
Glib::RefPtr<const Gtk::SizeGroupget_size_group () const
Glib::RefPtr<Gtk::SizeGroupget_size_group ()
CaptionStatus get_status () const
 Gets Hildon::Caption status.
const HildonCaption* gobj () const
 Provides access to the underlying C GtkObject.
HildonCaption* gobj ()
 Provides access to the underlying C GtkObject.
bool is_mandatory () const
 Query Hildon::Caption whether this captioned control is a mandatory one.
void set_child_expand (bool expand=true)
 Sets child expandability.
void set_icon_image (Gtk::Widget& icon)
 Sets the icon to be used by this hildon_caption widget.
void set_icon_position (CaptionIconPosition pos)
void set_label (const Glib::ustring& label)
 Sets the label text that appears before the control.
void set_label_alignment (float alignment)
 Sets the vertical alignment to be used for the text part of the caption.
void set_label_markup (const Glib::ustring& markup)
void set_separator (const Glib::ustring& separator)
 Sets the separator character that appears after the label.
void set_size_group (const Glib::RefPtr<Gtk::SizeGroup>& new_group)
void set_status (CaptionStatus flag)
 Sets Hildon::Caption status.
Glib::SignalProxy0<void> signal_activate ()
 
Prototype:
void activate()

virtual ~Caption ()

Related Functions

(Note that these are not member functions.)

Hildon::Captionwrap (HildonCaption* object, bool take_copy=false)
 
Parameters:
object The C instance


Constructor & Destructor Documentation

virtual Hildon::Caption::~Caption (  )  [virtual]

Hildon::Caption::Caption ( const Glib::RefPtr< Gtk::SizeGroup > &  group,
const Glib::ustring value,
Gtk::Widget child,
Gtk::Widget icon,
CaptionStatus  flag = CAPTION_OPTIONAL 
)

Hildon::Caption::Caption ( const Glib::ustring value,
Gtk::Widget child,
Gtk::Widget icon,
CaptionStatus  flag = CAPTION_OPTIONAL 
)

Hildon::Caption::Caption ( const Glib::ustring value,
Gtk::Widget child,
CaptionStatus  flag = CAPTION_OPTIONAL 
)


Member Function Documentation

bool Hildon::Caption::get_child_expand (  )  const

Gets childs expandability.

Returns : wheter the child is expandable or not.

const Gtk::Widget* Hildon::Caption::get_icon_image (  )  const

Gets icon of Hildon::Caption.

Returns : the Gtk::Image that is being used as the icon by the hildon_caption, or 0 if no icon is in use

Gtk::Widget* Hildon::Caption::get_icon_image (  ) 

Gets icon of Hildon::Caption.

Returns : the Gtk::Image that is being used as the icon by the hildon_caption, or 0 if no icon is in use

CaptionIconPosition Hildon::Caption::get_icon_position (  )  const

Glib::ustring Hildon::Caption::get_label (  )  const

Gets label of Hildon::Caption.

Returns : the text currently being used as the label of the caption control.

float Hildon::Caption::get_label_alignment (  )  const

Gets current vertical alignment for the text part.

Returns:
Vertical alignment
Since: 0.12.0.

Glib::ustring Hildon::Caption::get_separator (  )  const

Gets separator string of Hildon::Caption.

Returns : the text currently being used as the separator of the caption control.

Glib::RefPtr<const Gtk::SizeGroup> Hildon::Caption::get_size_group (  )  const

Glib::RefPtr<Gtk::SizeGroup> Hildon::Caption::get_size_group (  ) 

CaptionStatus Hildon::Caption::get_status (  )  const

Gets Hildon::Caption status.

Returns : one of the values from Hildon::CaptionStatus

const HildonCaption* Hildon::Caption::gobj (  )  const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::EventBox.

HildonCaption* Hildon::Caption::gobj (  )  [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::EventBox.

bool Hildon::Caption::is_mandatory (  )  const

Query Hildon::Caption whether this captioned control is a mandatory one.

Returns : is this captioned control a mandatory one?

void Hildon::Caption::set_child_expand ( bool  expand = true  ) 

Sets child expandability.

Parameters:
expand bool to determine is the child expandable.

void Hildon::Caption::set_icon_image ( Gtk::Widget icon  ) 

Sets the icon to be used by this hildon_caption widget.

Parameters:
icon The Gtk::Image to use as the icon. calls gtk_widget_show on the icon if !GTK_WIDGET_VISIBLE(icon).

void Hildon::Caption::set_icon_position ( CaptionIconPosition  pos  ) 

void Hildon::Caption::set_label ( const Glib::ustring label  ) 

Sets the label text that appears before the control.

Separator character is added to the end of the label string. By default the separator is ":".

Parameters:
label The text to use.

void Hildon::Caption::set_label_alignment ( float  alignment  ) 

Sets the vertical alignment to be used for the text part of the caption.

Applications need to align the child control themselves.

Since: 0.12.0

Parameters:
alignment New vertical alignment.

void Hildon::Caption::set_label_markup ( const Glib::ustring markup  ) 

void Hildon::Caption::set_separator ( const Glib::ustring separator  ) 

Sets the separator character that appears after the label.

The default seaparator character is ":" separately.

Parameters:
separator The separator to use.

void Hildon::Caption::set_size_group ( const Glib::RefPtr< Gtk::SizeGroup > &  new_group  ) 

void Hildon::Caption::set_status ( CaptionStatus  flag  ) 

Sets Hildon::Caption status.

Parameters:
flag One of the values from Hildon::CaptionStatus.

Glib::SignalProxy0< void > Hildon::Caption::signal_activate (  ) 

Prototype:
void activate()


Friends And Related Function Documentation

Hildon::Caption* wrap ( HildonCaption *  object,
bool  take_copy = false 
) [related]

Parameters:
object The C instance

Parameters:
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.


The documentation for this class was generated from the following file:
Generated for hildonmm by Doxygen 1.5.1 © 1997-2001