logo top
Main Page   Widgets   Namespaces   Book  

Gtk::AspectFrame Class Reference
[WidgetsContainer Widgets]

A frame that constrains its child to a particular aspect ratio. More...

Inheritance diagram for Gtk::AspectFrame:

Inheritance graph
[legend]
List of all members.

Public Methods

virtual ~AspectFrame ()
GtkAspectFrame* gobj ()
 Provides access to the underlying C GtkObject.

const GtkAspectFrame* gobj () const
 Provides access to the underlying C GtkObject.

 AspectFrame (const Glib::ustring& label=Glib::ustring(), AlignmentEnum xalign=Gtk::ALIGN_CENTER, AlignmentEnum yalign=Gtk::ALIGN_CENTER, float ratio=1.0, bool obey_child=false)
 Constructor to create a new AspectFrame object.

 AspectFrame (const Glib::ustring& label, float xalign, float yalign, float ratio=1.0, bool obey_child=false)
 Constructor to create a new AspectFrame object.

void set (float xalign, float yalign, float ratio, bool obey_child=true)
 Set the properties of this AspectFrame.

void set (AlignmentEnum xalign, AlignmentEnum yalign, float ratio, bool obey_child=true)
 Set the properties of this AspectFrame.

Glib::PropertyProxy<float> property_xalign ()
Glib::PropertyProxy<float> property_yalign ()
Glib::PropertyProxy<float> property_ratio ()
Glib::PropertyProxy<bool> property_obey_child ()

Related Functions

(Note that these are not member functions.)

Gtk::AspectFrame* wrap (GtkAspectFrame* object, bool take_copy=false)

Detailed Description

A frame that constrains its child to a particular aspect ratio.

The Gtk::AspectFrame is useful when you want pack a widget so that it can resize but always retains the same aspect ratio. For instance, one might be drawing a small preview of a larger image. Because it derives from Gtk::Frame, it can draw a label and a frame around the child. The frame will be "shrink-wrapped" to the size of the child.


Constructor & Destructor Documentation

virtual Gtk::AspectFrame::~AspectFrame (   [virtual]
 

Gtk::AspectFrame::AspectFrame ( const Glib::ustring   label = Glib::ustring(),
AlignmentEnum    xalign = Gtk::ALIGN_CENTER,
AlignmentEnum    yalign = Gtk::ALIGN_CENTER,
float    ratio = 1.0,
bool    obey_child = false
[explicit]
 

Constructor to create a new AspectFrame object.

Parameters:
label  Label text.
xalign  Horizontal alignment of the child within the allocation of this AspectFrame. For possible values, see Gtk::AlignmentEnum.
yalign  Vertical alignment of the child within the allocation of this AspectFrame. For possible values, see Gtk::AlignmentEnum.
ratio  The desired aspect ratio.
obey_child  If true, ratio is ignored and the aspect ratio is taken from the requisition of the child.

Gtk::AspectFrame::AspectFrame ( const Glib::ustring   label,
float    xalign,
float    yalign,
float    ratio = 1.0,
bool    obey_child = false
[explicit]
 

Constructor to create a new AspectFrame object.

Parameters:
label  Label text.
xalign  Horizontal alignment of the child within the allocation of this AspectFrame. This ranges from 0.0 (left aligned) to 1.0 (right aligned).
yalign  Vertical alignment of the child within the allocation of this AspectFrame. This ranges from 0.0 (top aligned) to 1.0 (bottom aligned).
ratio  The desired aspect ratio.
obey_child  If true, ratio is ignored and the aspect ratio is taken from the requisition of the child.


Member Function Documentation

const GtkAspectFrame* Gtk::AspectFrame::gobj (   const [inline]
 

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Frame.

GtkAspectFrame* Gtk::AspectFrame::gobj (   [inline]
 

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Frame.

Glib::PropertyProxy<bool> Gtk::AspectFrame::property_obey_child (  
 

Glib::PropertyProxy<float> Gtk::AspectFrame::property_ratio (  
 

Glib::PropertyProxy<float> Gtk::AspectFrame::property_xalign (  
 

Glib::PropertyProxy<float> Gtk::AspectFrame::property_yalign (  
 

void Gtk::AspectFrame::set ( AlignmentEnum    xalign,
AlignmentEnum    yalign,
float    ratio,
bool    obey_child = true
 

Set the properties of this AspectFrame.

Parameters:
xalign  Horizontal alignment of the child within the allocation of this AspectFrame. For possible values, see Gtk::AlignmentEnum.
yalign  Vertical alignment of the child within the allocation of this AspectFrame. For possible values, see Gtk::AlignmentEnum.
ratio  The desired aspect ratio.
obey_child  If true, ratio is ignored and the aspect ratio is taken from the requisition of the child.

void Gtk::AspectFrame::set ( float    xalign,
float    yalign,
float    ratio,
bool    obey_child = true
 

Set the properties of this AspectFrame.

Parameters:
xalign  Horizontal alignment of the child within the allocation of this AspectFrame. This ranges from 0.0 (left aligned) to 1.0 (right aligned).
yalign  Vertical alignment of the child within the allocation of this AspectFrame. This ranges from 0.0 (top aligned) to 1.0 (bottom aligned).
ratio  The desired aspect ratio.
obey_child  If true, ratio is ignored and the aspect ratio is taken from the requisition of the child.


Friends And Related Function Documentation

Gtk::AspectFrame* wrap ( GtkAspectFrame*    object,
bool    take_copy = false
[related]
 


The documentation for this class was generated from the following file:
Generated for gtkmm2.2 by Doxygen 1.2.18 © 1997-2001