


XmInstallImage(3X)					   XmInstallImage(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmIInnssttaallllIImmaaggee - A pixmap caching function that adds an image	to the pixmap
  cache

SYNOPSIS


  ##iinncclluuddee <<XXmm//XXmm..hh>>
  BBoooolleeaann XXmmIInnssttaallllIImmaaggee ((_i_m_a_g_e, _i_m_a_g_e__n_a_m_e))
       XXIImmaaggee	 * _i_m_a_g_e;;
       cchhaarr	 * _i_m_a_g_e__n_a_m_e;;

DESCRIPTION
  XXmmIInnssttaallllIImmaaggee stores	an image in an image cache that	can later be used to
  generate a pixmap.  Part of the installation process is to extend the
  resource converter used to reference these images.  The resource converter
  is given the image name so that the image can	be referenced in a .Xdefaults
  file.	 Since an image	can be referenced by a widget through its pixmap
  resources, it	is up to the application to ensure that	the image is
  installed before the widget is created.

  _i_m_a_g_e	    Points to the image	structure to be	installed.  The	installation
	    process does not make a local copy of the image.  Therefore, the
	    application	should not destroy the image until it is uninstalled
	    from the caching functions.

  _i_m_a_g_e__n_a_m_e
	    Specifies a	string that the	application uses to name the image.
	    After installation,	this name can be used in .Xdefaults for
	    referencing	the image.  A local copy of the	name is	created	by
	    the	image caching functions.

  The image caching functions provide a	set of eight preinstalled images.
  These	names can be used within a ..XXddeeffaauullttss file for generating pixmaps for
  the resource for which they are provided.

	 IImmaaggee NNaammee	 DDeessccrriippttiioonn
	 ____________________________________________________________
	 background	 A tile	of solid background
	 25_foreground	 A tile	of 25% foreground, 75% background
	 50_foreground	 A tile	of 50% foreground, 50% background
	 75_foreground	 A tile	of 75% foreground, 25% background
	 horizontal	 A tile	of horizontal lines of the two colors
	 vertical	 A tile	of vertical lines of the two colors
	 slant_right	 A tile	of slanting lines of the two colors
	 slant_left	 A tile	of slanting lines of the two colors

RETURN VALUE
  Returns True when successful;	returns	False if NULL _i_m_a_g_e, NULL _i_m_a_g_e__n_a_m_e,
  or duplicate _i_m_a_g_e__n_a_m_e is used as a parameter value.


RELATED	INFORMATION
  XXmmUUnniinnssttaallllIImmaaggee((33XX)),	XXmmGGeettPPiixxmmaapp((33XX)), and XXmmDDeessttrrooyyPPiixxmmaapp((33XX)).




