diff options
author | Owen Taylor <otaylor@src.gnome.org> | 1999-08-16 18:51:52 +0000 |
---|---|---|
committer | Owen Taylor <otaylor@src.gnome.org> | 1999-08-16 18:51:52 +0000 |
commit | 91a5956707f72e6ca4f57c2af51fab378bf22949 (patch) | |
tree | df292b9e1130dc0906526afadd0742d38ce480a9 /docs/reference/gtk/tmpl/gtkaspectframe.sgml | |
parent | 0455fa3029a4744fa40ab58bf4f837bfa1890509 (diff) | |
download | gdk-pixbuf-91a5956707f72e6ca4f57c2af51fab378bf22949.tar.gz |
Initial revision
Diffstat (limited to 'docs/reference/gtk/tmpl/gtkaspectframe.sgml')
-rw-r--r-- | docs/reference/gtk/tmpl/gtkaspectframe.sgml | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/reference/gtk/tmpl/gtkaspectframe.sgml b/docs/reference/gtk/tmpl/gtkaspectframe.sgml new file mode 100644 index 000000000..868a48868 --- /dev/null +++ b/docs/reference/gtk/tmpl/gtkaspectframe.sgml @@ -0,0 +1,71 @@ +<!-- ##### SECTION Title ##### --> +GtkAspectFrame + +<!-- ##### SECTION Short_Description ##### --> +A frame that constrains its child to a particular aspect ratio. + +<!-- ##### SECTION Long_Description ##### --> +<para> +The #GtkAspectFrame 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. #GtkAspectFrame +derives from #GtkFrame, so it can draw a label and +a frame around the child. The frame will be +"shrink-wrapped" to the size of the child. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT GtkAspectFrame ##### --> +<para> + +</para> + +@frame: +@xalign: +@yalign: +@ratio: +@obey_child: +@center_allocation: + +<!-- ##### FUNCTION gtk_aspect_frame_new ##### --> +<para> +Create a new #GtkAspectFrame. +</para> + +@label: Label text. +@xalign: Horizontal lignment of the child within the allocation of +the #GtkAspectFrame. This ranges from 0.0 (left aligned) +to 1.0 (right aligned) +@yalign: Vertical lignment of the child within the allocation of +the #GtkAspectFrame. This ranges from 0.0 (left aligned) +to 1.0 (right aligned) +@ratio: The desired aspect ratio. +@obey_child: If %TRUE, @ratio is ignored, and the aspect + ratio is taken from the requistion of the child. +@Returns: the new #GtkAspectFrame. +<!-- # Unused Parameters # --> +@ratio: The desired aspect ratio. + + +<!-- ##### FUNCTION gtk_aspect_frame_set ##### --> +<para> +Set parameters for an existing #GtkAspectFrame. +</para> + +@aspect_frame: a #GtkAspectFrame +@xalign: Horizontal lignment of the child within the allocation of +the #GtkAspectFrame. This ranges from 0.0 (left aligned) +to 1.0 (right aligned) +@yalign: Vertical lignment of the child within the allocation of +the #GtkAspectFrame. This ranges from 0.0 (left aligned) +to 1.0 (right aligned) +@ratio: The desired aspect ratio. +@obey_child: If %TRUE, @ratio is ignored, and the aspect + ratio is taken from the requistion of the child. + + |