Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkpixmap.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkPixmap
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 a widget displaying a graphical image or icon.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The #GtkPixmap widget displays a graphical image or icon.
  10 The icon is typically created using gdk_pixmap_colormap_create_from_xpm()
  11 or gdk_pixmap_colormap_create_from_xpm_d().
  12 </para>
  13 <para>
  14 The pixels in a #GtkPixmap cannot be manipulated by the application after
  15 creation, since under the X Window system the pixel data is stored on the
  16 X server and so is not available to the client application.
  17 If you want to create graphical images which can be manipulated by the
  18 application, look at #GtkImage and #GdkRGB.
  19 </para>
  20
  21 <!-- ##### SECTION See_Also ##### -->
  22 <para>
  23
  24 </para>
  25
  26 <!-- ##### STRUCT GtkPixmap ##### -->
  27 <para>
  28 The #GtkPixmap-struct struct contains private data only, and
  29 should be accessed using the functions below.
  30 </para>
  31
  32
  33 <!-- ##### FUNCTION gtk_pixmap_new ##### -->
  34 <para>
  35 Creates a new #GtkPixmap, using the given GDK pixmap and mask.
  36 </para>
  37
  38 @pixmap: a #GDKPixmap.
  39 @mask: a #GDKBitmap which indicates which parts of the @pixmap should be
  40 transparent.
  41 @Returns: a new #GtkPixmap.
  42
  43
  44 <!-- ##### FUNCTION gtk_pixmap_set ##### -->
  45 <para>
  46 Sets the #GdkPixmap and #GdkBitmap mask.
  47 </para>
  48
  49 @pixmap: a #GtkPixmap.
  50 @val: a #GdkPixmap.
  51 @mask: a #GdkBitmap, which indicates which parts of the @pixmap should be
  52 transparent. This can be NULL, in which case none of the @pixmap is
  53 transparent.
  54
  55
  56 <!-- ##### FUNCTION gtk_pixmap_get ##### -->
  57 <para>
  58 Gets the current #GdkPixmap and #GdkBitmap mask.
  59 </para>
  60
  61 @pixmap: a #GtkPixmap.
  62 @val: returns the current #GdkPixmap.
  63 @mask: returns the current #GdkBitmap mask.
  64
  65
  66 <!-- ##### FUNCTION gtk_pixmap_set_build_insensitive ##### -->
  67 <para>
  68
  69 </para>
  70
  71 @pixmap: a #GtkPixmap.
  72 @build: set to %TRUE if an extra pixmap should be automatically created to use
  73 when the pixmap is insensitive.
  74
  75