Manual Reference Pages - GTK2::EX::FORMFACTORY::IMAGE (3)
Gtk2::Ex::FormFactory::Image - An Image in a FormFactory framework
bgcolor => Background color of the widget,
with_frame => Draw a frame around the image?,
scale_to_fit => Automatially scale the image in its container?,
max_width => Maximum width the image may scale to,
max_height => Maximum height the image may scale to,
scale => Display the image with this constant scaling,
scale_hook => Callback which returns the actual scale,
This class implements an Image in a Gtk2::Ex::FormFactory framework.
The image is always displayed with its natural aspect ratio, but
there are various possibilities to control the scaling of the image.
The value of the associated application object attribute is the
filename of the displayed image. The file format must be supported
Attributes are handled through the common get_ATTR(), set_ATTR()
style accessors, but they are mostly passed once to the object
constructor and must not be altered after the associated FormFactory
For more attributes refer to Gtk2::Ex::FormFactory::Widget.
<B>bgcolorB> = RGB Hex Triple [optional]
This is the background color of the widget. If set all areas
of the widget not filled with the image are painted with this
<B>with_frameB> = BOOL [optional]
If set to TRUE a frame is rendered around the image.
<B>scale_to_fitB> = BOOL [optional]
If set to TRUE the image will automatically scale proportionally
into to the space the container of this widget allocated for the
<B>max_widthB> = INTEGER [optional]
With this attribute you can define a maximm width the image may
<B>max_heightB> = INTEGER [optional]
With this attribute you can define a maximm height the image may
<B>scaleB> = FLOAT [optional]
If you set this attribute, no dynamic scaling applies, but the
image will be constantly scaled with this value. This overrides
all other attributes regarding dynamic scaling.
<B>scale_hookB> = CODEREF(FormFactory::Image, PixBuf) [optional]
This code reference is called if the image needs an update
e.g. if the associated application object attribute changed or
the parent was resized and <B>scale_to_fitB> was set.
The Gtk2::Ex::FormFactory::Image instance and the Gtk2::Gdk::PixBuf
of the image are passed to the function.
If <B>scale_to_fitB> is set the widgets dimension are tracked
automatically. The actual width and height are stored in the
attributes <B>widget_widthB> and <B>widget_heightB> and thus can
be accessed from the callback by calling <B>get_widget_widthB>
Joern Reder <joern at zyn dot de>
COPYRIGHT AND LICENSE
Copyright 2004-2006 by Joern Reder.
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.1 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307
Hey! <B>The above document had some coding errors, which are explained below:B>
Around line 259:
Non-ASCII character seen before =encoding in Joern. Assuming ISO8859-1
|perl v5.20.3 ||GTK2::EX::FORMFACTORY::IMAGE (3) ||2006-02-27 |
Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.