1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
/* $Id: aspectframe.hg,v 1.2 2003/03/03 07:49:05 murrayc Exp $ */
/* aspectframe.h
*
* Copyright (C) 1998-2002 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <gtkmm/frame.h>
_DEFS(gtkmm,gtk)
_PINCLUDE(gtkmm/private/frame_p.h)
namespace Gtk
{
/** 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.
*
* @ingroup Widgets
* @ingroup Containers
*/
class AspectFrame : public Frame
{
_CLASS_GTKOBJECT(AspectFrame,GtkAspectFrame,GTK_ASPECT_FRAME,Gtk::Frame,GtkFrame)
public:
/** Constructor to create a new AspectFrame object.
* @param label Label text.
* @param xalign Horizontal alignment of the child within the allocation of this
* AspectFrame. For possible values, see Gtk::AlignmentEnum.
* @param yalign Vertical alignment of the child within the allocation of this
* AspectFrame. For possible values, see Gtk::AlignmentEnum.
* @param ratio The desired aspect ratio.
* @param obey_child If <tt>true</tt>, @a ratio is ignored and the aspect ratio
* is taken from the requisition of the child.
*/
_WRAP_CTOR(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), gtk_aspect_frame_new)
/** Constructor to create a new AspectFrame object.
* @param label Label text.
* @param xalign Horizontal alignment of the child within the allocation of this
* AspectFrame. This ranges from 0.0 (left aligned) to 1.0 (right aligned).
* @param yalign Vertical alignment of the child within the allocation of this
* AspectFrame. This ranges from 0.0 (top aligned) to 1.0 (bottom aligned).
* @param ratio The desired aspect ratio.
* @param obey_child If <tt>true</tt>, @a ratio is ignored and the aspect ratio
* is taken from the requisition of the child.
*/
_WRAP_CTOR(AspectFrame(const Glib::ustring& label,
float xalign, float yalign,
float ratio = 1.0, bool obey_child = false), gtk_aspect_frame_new)
//TODO: Is "obey_child = true" a good default?
/** Set the properties of this AspectFrame.
* @param xalign Horizontal alignment of the child within the allocation of this
* AspectFrame. This ranges from 0.0 (left aligned) to 1.0 (right aligned).
* @param yalign Vertical alignment of the child within the allocation of this
* AspectFrame. This ranges from 0.0 (top aligned) to 1.0 (bottom aligned).
* @param ratio The desired aspect ratio.
* @param obey_child If <tt>true</tt>, @a ratio is ignored and the aspect ratio
* is taken from the requisition of the child.
*/
_WRAP_METHOD(void set(float xalign, float yalign, float ratio, bool obey_child = true), gtk_aspect_frame_set)
/** Set the properties of this AspectFrame.
* @param xalign Horizontal alignment of the child within the allocation of this
* AspectFrame. For possible values, see Gtk::AlignmentEnum.
* @param yalign Vertical alignment of the child within the allocation of this
* AspectFrame. For possible values, see Gtk::AlignmentEnum.
* @param ratio The desired aspect ratio.
* @param obey_child If <tt>true</tt>, @a ratio is ignored and the aspect ratio
* is taken from the requisition of the child.
*/
_WRAP_METHOD(void set(AlignmentEnum xalign, AlignmentEnum yalign, float ratio, bool obey_child = true), gtk_aspect_frame_set)
_WRAP_PROPERTY("xalign", float)
_WRAP_PROPERTY("yalign", float)
_WRAP_PROPERTY("ratio", float)
_WRAP_PROPERTY("obey-child", bool)
};
} /* namespace Gtk */
|
