gdk.Colormap.Colormap Class Reference

List of all members.

Detailed Description

Description These functions are used to modify colormaps.

A colormap is an object that contains the mapping between the color values stored in memory and the RGB values that are used to display color values. In general, colormaps only contain significant information for pseudo-color visuals, but even for other visual types, a colormap object is required in some circumstances. There are a couple of special colormaps that can be retrieved. The system colormap (retrieved with gdk_colormap_get_system()) is the default colormap of the system. If you are using GdkRGB, there is another colormap that is important - the colormap in which GdkRGB works, retrieved with gdk_rgb_get_cmap(). However, when using GdkRGB, it is not generally necessary to allocate colors directly. In previous revisions of this interface, a number of functions that take a GdkColormap parameter were replaced with functions whose names began with "gdk_colormap_". This process will probably be extended somewhat in the future - gdk_color_white(), gdk_color_black(), and gdk_color_change() will probably become aliases.


Public Member Functions

GdkColormapgetColormapStruct ()
 this (GdkColormap *gdkColormap)
 Sets our main struct and passes it to the parent class.
 this (Visual visual, int allocate)
 Creates a new colormap for the given visual.
Colormap ref ()
 Warning gdk_colormap_ref is deprecated and should not be used in newly-written code.
void unref ()
 Warning gdk_colormap_unref is deprecated and should not be used in newly-written code.
void change (int ncolors)
 Warning gdk_colormap_change is deprecated and should not be used in newly-written code.
int allocColors (Color colors, int ncolors, int writeable, int bestMatch, int *success)
 Allocates colors from a colormap.
int allocColor (Color color, int writeable, int bestMatch)
 Allocates a single color from a colormap.
void freeColors (Color colors, int ncolors)
 Frees previously allocated colors.
void queryColor (uint pixel, Color result)
 Locates the RGB color in colormap corresponding to the given hardware pixel pixel.
Visual getVisual ()
 Returns the visual for which a given colormap was created.
Screen getScreen ()
 Gets the screen for which this colormap was created.
void gdkColorsStore (Color colors, int ncolors)
 Warning gdk_colors_store is deprecated and should not be used in newly-written code.
int gdkColorsAlloc (int contiguous, uint *planes, int nplanes, uint *pixels, int npixels)
 Warning gdk_colors_alloc is deprecated and should not be used in newly-written code.
void gdkColorsFree (uint *pixels, int npixels, uint planes)
 Warning gdk_colors_free is deprecated and should not be used in newly-written code.

Static Public Member Functions

static Colormap getSystem ()
 Gets the system's default colormap for the default screen.
static int getSystemSize ()
 Warning gdk_colormap_get_system_size is deprecated and should not be used in newly-written code.

Protected Member Functions

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

Protected Attributes

GdkColormapgdkColormap
 the main Gtk struct


Constructor & Destructor Documentation

gdk.Colormap.Colormap.this ( GdkColormap gdkColormap  ) 

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

gdk.Colormap.Colormap.this ( Visual  visual,
int  allocate 
)

Creates a new colormap for the given visual.

visual: a GdkVisual. allocate: if TRUE, the newly created colormap will be a private colormap, and all colors in it will be allocated for the applications use. Returns: the new GdkColormap.


Member Function Documentation

int gdk.Colormap.Colormap.allocColor ( Color  color,
int  writeable,
int  bestMatch 
)

Allocates a single color from a colormap.

colormap: a GdkColormap. color: the color to allocate. On return the pixel field will be filled in if allocation succeeds. writeable: If TRUE, the color is allocated writeable (their values can later be changed using gdk_color_change()). Writeable colors cannot be shared between applications. best_match: If TRUE, GDK will attempt to do matching against existing colors if the color cannot be allocated as requested. Returns: TRUE if the allocation succeeded.

int gdk.Colormap.Colormap.allocColors ( Color  colors,
int  ncolors,
int  writeable,
int  bestMatch,
int success 
)

Allocates colors from a colormap.

colormap: a GdkColormap. colors: The color values to allocate. On return, the pixel values for allocated colors will be filled in. ncolors: The number of colors in colors. writeable: If TRUE, the colors are allocated writeable (their values can later be changed using gdk_color_change()). Writeable colors cannot be shared between applications. best_match: If TRUE, GDK will attempt to do matching against existing colors if the colors cannot be allocated as requested. success: An array of length ncolors. On return, this indicates whether the corresponding color in colors was successfully allocated or not. Returns: The number of colors that were not successfully allocated.

void gdk.Colormap.Colormap.change ( int  ncolors  ) 

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

Changes the value of the first ncolors in a private colormap to match the values in the colors array in the colormap. This function is obsolete and should not be used. See gdk_color_change(). colormap: a GdkColormap. ncolors: the number of colors to change.

void gdk.Colormap.Colormap.freeColors ( Color  colors,
int  ncolors 
)

Frees previously allocated colors.

colormap: a GdkColormap. colors: the colors to free. ncolors: the number of colors in colors.

int gdk.Colormap.Colormap.gdkColorsAlloc ( int  contiguous,
uint planes,
int  nplanes,
uint pixels,
int  npixels 
)

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

Allocates colors from a colormap. This function is obsolete. See gdk_colormap_alloc_colors(). For full documentation of the fields, see the Xlib documentation for XAllocColorCells(). colormap: a GdkColormap. contiguous: if TRUE, the colors should be allocated in contiguous color cells. planes: an array in which to store the plane masks. nplanes: the number of planes to allocate. (Or zero, to indicate that the color allocation should not be planar.) pixels: an array into which to store allocated pixel values. npixels: the number of pixels in each plane to allocate. Returns: TRUE if the allocation was successful

void gdk.Colormap.Colormap.gdkColorsFree ( uint pixels,
int  npixels,
uint  planes 
)

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

Frees colors allocated with gdk_colors_alloc(). This function is obsolete. See gdk_colormap_free_colors(). colormap: a GdkColormap. pixels: the pixel values of the colors to free. npixels: the number of values in pixels. planes: the plane masks for all planes to free, OR'd together.

void gdk.Colormap.Colormap.gdkColorsStore ( Color  colors,
int  ncolors 
)

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

Changes the value of the first ncolors colors in a private colormap. This function is obsolete and should not be used. See gdk_color_change(). colormap: a GdkColormap. colors: the new color values. ncolors: the number of colors to change.

GdkColormap* gdk.Colormap.Colormap.getColormapStruct (  ) 

Screen gdk.Colormap.Colormap.getScreen (  ) 

Gets the screen for which this colormap was created.

cmap: a GdkColormap Returns: the screen for which this colormap was created. Since 2.2

void* gdk.Colormap.Colormap.getStruct (  )  [protected]

the main Gtk struct as a void*

static Colormap gdk.Colormap.Colormap.getSystem (  )  [static]

Gets the system's default colormap for the default screen.

(See gdk_colormap_get_system_for_screen()) Returns: the default colormap.

static int gdk.Colormap.Colormap.getSystemSize (  )  [static]

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

Returns the size of the system's default colormap. (See the description of struct GdkColormap for an explanation of the size of a colormap.) Returns: the size of the system's default colormap.

Visual gdk.Colormap.Colormap.getVisual (  ) 

Returns the visual for which a given colormap was created.

colormap: a GdkColormap. Returns: the visual of the colormap.

void gdk.Colormap.Colormap.queryColor ( uint  pixel,
Color  result 
)

Locates the RGB color in colormap corresponding to the given hardware pixel pixel.

pixel must be a valid pixel in the colormap; it's a programmer error to call this function with a pixel which is not in the colormap. Hardware pixels are normally obtained from gdk_colormap_alloc_colors(), or from a GdkImage. (A GdkImage contains image data in hardware format, a GdkPixbuf contains image data in a canonical 24-bit RGB format.) This function is rarely useful; it's used for example to implement the eyedropper feature in GtkColorSelection. colormap: a GdkColormap pixel: pixel value in hardware display format result: GdkColor with red, green, blue fields initialized

Colormap gdk.Colormap.Colormap.ref (  ) 

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

Deprecated function; use g_object_ref() instead. cmap: a GdkColormap Returns: the colormap

void gdk.Colormap.Colormap.unref (  ) 

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

Deprecated function; use g_object_ref() instead. cmap: a GdkColormap


Member Data Documentation

GdkColormap* gdk.Colormap.Colormap.gdkColormap [protected]

the main Gtk struct


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