gtk.Image.Image Class Reference

Inheritance diagram for gtk.Image.Image:

gtk.Misc.Misc gtk.Widget.Widget gtk.ObjectGtk.ObjectGtk gobject.ObjectG.ObjectG List of all members.

Public Member Functions

GtkImagegetImageStruct ()
 this (GtkImage *gtkImage)
 Sets our main struct and passes it to the parent class.
 this (StockID stockID, GtkIconSize size)
 Creates a GtkImage displaying a stock icon.
 this (char[] iconName, GtkIconSize size)
 Creates a GtkImage displaying an icon from the current icon theme.
void getIconSet (GtkIconSet **iconSet, GtkIconSize *size)
 Gets the icon set and size being displayed by the GtkImage.
void getImage (GdkImage **gdkImage, GdkBitmap **mask)
 Gets the GdkImage and mask being displayed by the GtkImage.
Pixbuf getPixbuf ()
 Gets the GdkPixbuf being displayed by the GtkImage.
void getPixmap (GdkPixmap **pixmap, GdkBitmap **mask)
 Gets the pixmap and mask being displayed by the GtkImage.
void getStock (char **stockId, GtkIconSize *size)
 Gets the stock icon name and size being displayed by the GtkImage.
GdkPixbufAnimation * getAnimation ()
 Gets the GdkPixbufAnimation being displayed by the GtkImage.
void getIconName (char **iconName, GtkIconSize *size)
 Gets the icon name and size being displayed by the GtkImage.
GtkImageType getStorageType ()
 Gets the type of representation being used by the GtkImage to store image data.
 this (char[] filename)
 Creates a new GtkImage displaying the file filename.
 this (GtkIconSet *iconSet, GtkIconSize size)
 Creates a GtkImage displaying an icon set.
 this (ImageGdk image, Bitmap mask)
 Creates a GtkImage widget displaying a image with a mask.
 this (Pixbuf pixbuf)
 Creates a new GtkImage displaying pixbuf.
 this (Pixmap pixmap, Bitmap mask)
 Creates a GtkImage widget displaying pixmap with a mask.
 this (GdkPixbufAnimation *animation)
 Creates a GtkImage displaying the given animation.
void setFromFile (char[] filename)
 See gtk_image_new_from_file() for details.
void setFromIconSet (GtkIconSet *iconSet, GtkIconSize size)
 See gtk_image_new_from_icon_set() for details.
void setFromImage (ImageGdk gdkImage, Bitmap mask)
 See gtk_image_new_from_image() for details.
void setFromPixbuf (Pixbuf pixbuf)
 See gtk_image_new_from_pixbuf() for details.
void setFromPixmap (Pixmap pixmap, Bitmap mask)
 See gtk_image_new_from_pixmap() for details.
void setFromStock (char[] stockId, GtkIconSize size)
 See gtk_image_new_from_stock() for details.
void setFromAnimation (GdkPixbufAnimation *animation)
 Causes the GtkImage to display the given animation (or display nothing, if you set the animation to NULL).
void setFromIconName (char[] iconName, GtkIconSize size)
 See gtk_image_new_from_icon_name() for details.
void clear ()
 Resets the image to be empty.
 this ()
 Creates a new empty GtkImage widget.
void set (ImageGdk val, Bitmap mask)
 Warning gtk_image_set is deprecated and should not be used in newly-written code.
void get (GdkImage **val, GdkBitmap **mask)
 Warning gtk_image_get is deprecated and should not be used in newly-written code.
void setPixelSize (int pixelSize)
 Sets the pixel size to use for named icons.
int getPixelSize ()
 Gets the pixel size used for named icons.

Protected Member Functions

void * getStruct ()
 the main Gtk struct as a void*

Protected Attributes

GtkImagegtkImage
 the main Gtk struct

Constructor & Destructor Documentation

gtk.Image.Image.this ( GtkImage gtkImage  ) 

Sets our main struct and passes it to the parent class.

gtk.Image.Image.this ( StockID  stockID,
GtkIconSize  size 
)

Creates a GtkImage displaying a stock icon.

Sample stock icon names are GTK_STOCK_OPEN, GTK_STOCK_EXIT. Sample stock sizes are GTK_ICON_SIZE_MENU, GTK_ICON_SIZE_SMALL_TOOLBAR. If the stock icon name isn't known, the image will be empty. You can register your own stock icon names, see gtk_icon_factory_add_default() and gtk_icon_factory_add(). stock_id: a stock icon name size: a stock icon size Returns: a new GtkImage displaying the stock icon

gtk.Image.Image.this ( char[]  iconName,
GtkIconSize  size 
)

Creates a GtkImage displaying an icon from the current icon theme.

If the icon name isn't known, a "broken image" icon will be displayed instead. If the current icon theme is changed, the icon will be updated appropriately. icon_name: an icon name size: a stock icon size Returns: a new GtkImage displaying the themed icon Since 2.6

gtk.Image.Image.this ( char[]  filename  ) 

Creates a new GtkImage displaying the file filename.

If the file isn't found or can't be loaded, the resulting GtkImage will display a "broken image" icon. This function never returns NULL, it always returns a valid GtkImage widget. If the file contains an animation, the image will contain an animation. If you need to detect failures to load the file, use gdk_pixbuf_new_from_file() to load the file yourself, then create the GtkImage from the pixbuf. (Or for animations, use gdk_pixbuf_animation_new_from_file()). The storage type (gtk_image_get_storage_type()) of the returned image is not defined, it will be whatever is appropriate for displaying the file. filename: a filename Returns: a new GtkImage

gtk.Image.Image.this ( GtkIconSet iconSet,
GtkIconSize  size 
)

Creates a GtkImage displaying an icon set.

Sample stock sizes are GTK_ICON_SIZE_MENU, GTK_ICON_SIZE_SMALL_TOOLBAR. Instead of using this function, usually it's better to create a GtkIconFactory, put your icon sets in the icon factory, add the icon factory to the list of default factories with gtk_icon_factory_add_default(), and then use gtk_image_new_from_stock(). This will allow themes to override the icon you ship with your application. The GtkImage does not assume a reference to the icon set; you still need to unref it if you own references. GtkImage will add its own reference rather than adopting yours. icon_set: a GtkIconSet size: a stock icon size Returns: a new GtkImage

gtk.Image.Image.this ( ImageGdk  image,
Bitmap  mask 
)

Creates a GtkImage widget displaying a image with a mask.

A GdkImage is a client-side image buffer in the pixel format of the current display. The GtkImage does not assume a reference to the image or mask; you still need to unref them if you own references. GtkImage will add its own reference rather than adopting yours. image: a GdkImage, or NULL mask: a GdkBitmap, or NULL Returns: a new GtkImage

gtk.Image.Image.this ( Pixbuf  pixbuf  ) 

Creates a new GtkImage displaying pixbuf.

The GtkImage does not assume a reference to the pixbuf; you still need to unref it if you own references. GtkImage will add its own reference rather than adopting yours. Note that this function just creates an GtkImage from the pixbuf. The GtkImage created will not react to state changes. Should you want that, you should use gtk_image_new_from_icon_set(). pixbuf: a GdkPixbuf, or NULL Returns: a new GtkImage

gtk.Image.Image.this ( Pixmap  pixmap,
Bitmap  mask 
)

Creates a GtkImage widget displaying pixmap with a mask.

A GdkPixmap is a server-side image buffer in the pixel format of the current display. The GtkImage does not assume a reference to the pixmap or mask; you still need to unref them if you own references. GtkImage will add its own reference rather than adopting yours. pixmap: a GdkPixmap, or NULL mask: a GdkBitmap, or NULL Returns: a new GtkImage

gtk.Image.Image.this ( GdkPixbufAnimation *  animation  ) 

Creates a GtkImage displaying the given animation.

The GtkImage does not assume a reference to the animation; you still need to unref it if you own references. GtkImage will add its own reference rather than adopting yours. Note that the animation frames are shown using a timeout with G_PRIORITY_DEFAULT. When using animations to indicate busyness, keep in mind that the animation will only be shown if the main loop is not busy with something that has a higher priority. animation: an animation Returns: a new GtkImage widget

gtk.Image.Image.this (  ) 

Creates a new empty GtkImage widget.

Returns: a newly created GtkImage widget.


Member Function Documentation

void gtk.Image.Image.clear (  ) 

Resets the image to be empty.

image: a GtkImage Since 2.8

void gtk.Image.Image.get ( GdkImage **  val,
GdkBitmap **  mask 
)

Warning gtk_image_get is deprecated and should not be used in newly-written code.

Gets the GtkImage. image: a GtkImage val: return location for a GdkImage mask: a GdkBitmap that indicates which parts of the image should be transparent.

GdkPixbufAnimation* gtk.Image.Image.getAnimation (  ) 

Gets the GdkPixbufAnimation being displayed by the GtkImage.

The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_ANIMATION (see gtk_image_get_storage_type()). The caller of this function does not own a reference to the returned animation. image: a GtkImage Returns: the displayed animation, or NULL if the image is empty

void gtk.Image.Image.getIconName ( char **  iconName,
GtkIconSize size 
)

Gets the icon name and size being displayed by the GtkImage.

The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_ICON_NAME (see gtk_image_get_storage_type()). The returned string is owned by the GtkImage and should not be freed. image: a GtkImage icon_name: place to store an icon name size: place to store an icon size Since 2.6

void gtk.Image.Image.getIconSet ( GtkIconSet **  iconSet,
GtkIconSize size 
)

Gets the icon set and size being displayed by the GtkImage.

The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_ICON_SET (see gtk_image_get_storage_type()). image: a GtkImage icon_set: location to store a GtkIconSet size: location to store a stock icon size

void gtk.Image.Image.getImage ( GdkImage **  gdkImage,
GdkBitmap **  mask 
)

Gets the GdkImage and mask being displayed by the GtkImage.

The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_IMAGE (see gtk_image_get_storage_type()). The caller of this function does not own a reference to the returned image and mask. image: a GtkImage gdk_image: return location for a GtkImage mask: return location for a GdkBitmap

GtkImage* gtk.Image.Image.getImageStruct (  ) 

Pixbuf gtk.Image.Image.getPixbuf (  ) 

Gets the GdkPixbuf being displayed by the GtkImage.

The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_PIXBUF (see gtk_image_get_storage_type()). The caller of this function does not own a reference to the returned pixbuf. image: a GtkImage Returns: the displayed pixbuf, or NULL if the image is empty

int gtk.Image.Image.getPixelSize (  ) 

Gets the pixel size used for named icons.

image: a GtkImage Returns: the pixel size used for named icons. Since 2.6 Property Details The "file" property "file" gchararray : Read / Write Filename to load and display. Default value: NULL

void gtk.Image.Image.getPixmap ( GdkPixmap **  pixmap,
GdkBitmap **  mask 
)

Gets the pixmap and mask being displayed by the GtkImage.

The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_PIXMAP (see gtk_image_get_storage_type()). The caller of this function does not own a reference to the returned pixmap and mask. image: a GtkImage pixmap: location to store the pixmap, or NULL mask: location to store the mask, or NULL

void gtk.Image.Image.getStock ( char **  stockId,
GtkIconSize size 
)

Gets the stock icon name and size being displayed by the GtkImage.

The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_STOCK (see gtk_image_get_storage_type()). The returned string is owned by the GtkImage and should not be freed. image: a GtkImage stock_id: place to store a stock icon name size: place to store a stock icon size

GtkImageType gtk.Image.Image.getStorageType (  ) 

Gets the type of representation being used by the GtkImage to store image data.

If the GtkImage has no image data, the return value will be GTK_IMAGE_EMPTY. image: a GtkImage Returns: image representation being used

void* gtk.Image.Image.getStruct (  )  [protected]

the main Gtk struct as a void*

Reimplemented from gtk.Misc.Misc.

void gtk.Image.Image.set ( ImageGdk  val,
Bitmap  mask 
)

Warning gtk_image_set is deprecated and should not be used in newly-written code.

Sets the GtkImage. image: a GtkImage val: a GdkImage mask: a GdkBitmap that indicates which parts of the image should be transparent.

void gtk.Image.Image.setFromAnimation ( GdkPixbufAnimation *  animation  ) 

Causes the GtkImage to display the given animation (or display nothing, if you set the animation to NULL).

image: a GtkImage animation: the GdkPixbufAnimation

void gtk.Image.Image.setFromFile ( char[]  filename  ) 

See gtk_image_new_from_file() for details.

image: a GtkImage filename: a filename or NULL

void gtk.Image.Image.setFromIconName ( char[]  iconName,
GtkIconSize  size 
)

See gtk_image_new_from_icon_name() for details.

image: a GtkImage icon_name: an icon name size: an icon size Since 2.6

void gtk.Image.Image.setFromIconSet ( GtkIconSet iconSet,
GtkIconSize  size 
)

See gtk_image_new_from_icon_set() for details.

image: a GtkImage icon_set: a GtkIconSet size: a stock icon size

void gtk.Image.Image.setFromImage ( ImageGdk  gdkImage,
Bitmap  mask 
)

See gtk_image_new_from_image() for details.

image: a GtkImage gdk_image: a GdkImage or NULL mask: a GdkBitmap or NULL

void gtk.Image.Image.setFromPixbuf ( Pixbuf  pixbuf  ) 

See gtk_image_new_from_pixbuf() for details.

image: a GtkImage pixbuf: a GdkPixbuf or NULL

void gtk.Image.Image.setFromPixmap ( Pixmap  pixmap,
Bitmap  mask 
)

See gtk_image_new_from_pixmap() for details.

image: a GtkImage pixmap: a GdkPixmap or NULL mask: a GdkBitmap or NULL

void gtk.Image.Image.setFromStock ( char[]  stockId,
GtkIconSize  size 
)

See gtk_image_new_from_stock() for details.

image: a GtkImage stock_id: a stock icon name size: a stock icon size

void gtk.Image.Image.setPixelSize ( int  pixelSize  ) 

Sets the pixel size to use for named icons.

If the pixel size is set to a value != -1, it is used instead of the icon size set by gtk_image_set_from_icon_name(). image: a GtkImage pixel_size: the new pixel size Since 2.6


Member Data Documentation

GtkImage* gtk.Image.Image.gtkImage [protected]

the main Gtk struct


SourceForge.net Logo DSource.org Logo digitalmars.com Logo