<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>gtkmm 2.4: Gdk::Colormap Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
<td width="10%" height="40"><img src="../../images/gtkmm_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
<td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
</tr>
</table>
<center>
<a class="qindex" href="../../index.html">Main Page</a>
<a href="group__Widgets.html">Widgets</a>
<a class="qindex" href="namespaces.html"> Namespaces</a>
<a href="../../tutorial/html/index.html"> Book</a>
</center>
<hr width="100%"/>
<!-- begin main content -->
<div id="content">
<!-- Generated by Doxygen 1.5.1 -->
<div class="nav">
<a class="el" href="namespaceGdk.html">Gdk</a>::<a class="el" href="classGdk_1_1Colormap.html">Colormap</a></div>
<h1>Gdk::Colormap Class Reference</h1><!-- doxytag: class="Gdk::Colormap" --><!-- doxytag: inherits="Glib::Object" -->Inheritance diagram for Gdk::Colormap:<p><center><img src="classGdk_1_1Colormap__inherit__graph.png" border="0" usemap="#Gdk_1_1Colormap__inherit__map" alt="Inheritance graph"></center>
<map name="Gdk_1_1Colormap__inherit__map">
<area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1Object.html" shape="rect" coords="21,161,115,188" alt="">
<area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ObjectBase.html" shape="rect" coords="5,84,131,111" alt="">
<area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classsigc_1_1trackable.html" shape="rect" coords="12,7,124,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classGdk_1_1Colormap-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
A <a class="el" href="classGdk_1_1Colormap.html">Colormap</a> 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.
<p>
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.<p>
There are a couple of special colormaps that can be retrieved. The system colormap (retrieved with <a class="el" href="classGdk_1_1Colormap.html#78c9dfeafac5833684299e8b1b5ce016">get_system()</a>) 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 <a class="el" href="namespaceGdk.html#37e62b12aa3ddf44b4f69e05d8893b5a">Gdk::rgb_get_colormap()</a>. However, when using GdkRGB, it is not generally necessary to allocate colors directly.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Colormap.html#798a90a164bd95a865360b573455407c">alloc_color</a> (<a class="el" href="classGdk_1_1Color.html">Color</a>& color, bool writeable=false, bool best_match=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocates a single color from a colormap. <a href="#798a90a164bd95a865360b573455407c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Colormap.html#572fe8fade77afbdcc7f7cf56ff489f6">alloc_colors</a> (<a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ArrayHandle.html">ArrayHandle_Color</a>& colors, int ncolors, bool writeable, bool best_match, <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a><bool>& success)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Colormap.html#abb71a757b4f69a90d0fca884a6b4c62">free_color</a> (<a class="el" href="classGdk_1_1Color.html">Color</a>& color)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Colormap.html#79d4fec03cb95c71b64d4a0bc6282fe6">free_colors</a> (<a class="el" href="classGdk_1_1Color.html">Color</a>& colors, int ncolors)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classGdk_1_1Screen.html">Screen</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Colormap.html#1d845482061a428a5b82b478cfb83cbd">get_screen</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the screen for which this colormap was created. <a href="#1d845482061a428a5b82b478cfb83cbd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Screen.html">Screen</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Colormap.html#0de4faa551cfccf109947e9af4dee7ff">get_screen</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the screen for which this colormap was created. <a href="#0de4faa551cfccf109947e9af4dee7ff"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classGdk_1_1Visual.html">Visual</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Colormap.html#45ed1e6f405f7aa1d0d60b2d878c1c43">get_visual</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return value: the visual of the colormap. <a href="#45ed1e6f405f7aa1d0d60b2d878c1c43"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Visual.html">Visual</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Colormap.html#90d5e438d78992e2030832a196ac222b">get_visual</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return value: the visual of the colormap. <a href="#90d5e438d78992e2030832a196ac222b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const GdkColormap* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Colormap.html#b13d6b3f34ac026eef002c2788839f4b">gobj</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#b13d6b3f34ac026eef002c2788839f4b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GdkColormap* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Colormap.html#8e073a91f54ca4f7443db9e1d514bb52">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#8e073a91f54ca4f7443db9e1d514bb52"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GdkColormap* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Colormap.html#8bc022fb6ea4673159155bca8e730a39">gobj_copy</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#8bc022fb6ea4673159155bca8e730a39"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Colormap.html#c3c3335c6f0ceab1ab75d3f9bd25f53f">query_color</a> (gulong pixel, <a class="el" href="classGdk_1_1Color.html">Color</a>& result)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Locates the RGB color in <em>colormap</em> corresponding to the given hardware pixel <em>pixel</em> . <a href="#c3c3335c6f0ceab1ab75d3f9bd25f53f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Colormap.html#527fe5eab97c19bb3d1fcedb933ecd13">~Colormap</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Colormap.html">Colormap</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Colormap.html#9447b914e4f6d73ff2d041350791ade1">create</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Visual.html">Visual</a>>& visual, bool allocate)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Colormap.html">Colormap</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Colormap.html#78c9dfeafac5833684299e8b1b5ce016">get_system</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the system's default colormap for the default screen. <a href="#78c9dfeafac5833684299e8b1b5ce016"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Colormap.html#b617d305ec0582e6a762ed97016dac09">Colormap</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Visual.html">Visual</a>>& visual, bool allocate)</td></tr>
<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Colormap.html">Gdk::Colormap</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Colormap.html#73e55bc63cbc380d36c3d382a47be80a">wrap</a> (GdkColormap* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#73e55bc63cbc380d36c3d382a47be80a"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="527fe5eab97c19bb3d1fcedb933ecd13"></a><!-- doxytag: member="Gdk::Colormap::~Colormap" ref="527fe5eab97c19bb3d1fcedb933ecd13" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gdk::Colormap::~Colormap </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="b617d305ec0582e6a762ed97016dac09"></a><!-- doxytag: member="Gdk::Colormap::Colormap" ref="b617d305ec0582e6a762ed97016dac09" args="(const Glib::RefPtr< Visual > &visual, bool allocate)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gdk::Colormap::Colormap </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Visual.html">Visual</a>>& </td>
<td class="paramname"> <em>visual</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>allocate</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [explicit, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="798a90a164bd95a865360b573455407c"></a><!-- doxytag: member="Gdk::Colormap::alloc_color" ref="798a90a164bd95a865360b573455407c" args="(Color &color, bool writeable=false, bool best_match=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gdk::Colormap::alloc_color </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGdk_1_1Color.html">Color</a>& </td>
<td class="paramname"> <em>color</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>writeable</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>best_match</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allocates a single color from a colormap.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>color</em> </td><td>The color to allocate. On return the <structfield>pixel</structfield> field will be filled in if allocation succeeds. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>writeable</em> </td><td>If <code>true</code>, the color is allocated writeable (their values can later be changed using gdk_color_change()). Writeable colors cannot be shared between applications. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>best_match</em> </td><td>If <code>true</code>, GDK will attempt to do matching against existing colors if the color cannot be allocated as requested. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if the allocation succeeded. </dd></dl>
</div>
</div><p>
<a class="anchor" name="572fe8fade77afbdcc7f7cf56ff489f6"></a><!-- doxytag: member="Gdk::Colormap::alloc_colors" ref="572fe8fade77afbdcc7f7cf56ff489f6" args="(ArrayHandle_Color &colors, int ncolors, bool writeable, bool best_match, Glib::ArrayHandle< bool > &success)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Gdk::Colormap::alloc_colors </td>
<td>(</td>
<td class="paramtype"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ArrayHandle.html">ArrayHandle_Color</a> & </td>
<td class="paramname"> <em>colors</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>ncolors</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>writeable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>best_match</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< bool > & </td>
<td class="paramname"> <em>success</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd>Use <a class="el" href="classGdk_1_1Colormap.html#798a90a164bd95a865360b573455407c">alloc_color()</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="9447b914e4f6d73ff2d041350791ade1"></a><!-- doxytag: member="Gdk::Colormap::create" ref="9447b914e4f6d73ff2d041350791ade1" args="(const Glib::RefPtr< Visual > &visual, bool allocate)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Colormap.html">Colormap</a>> Gdk::Colormap::create </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Visual.html">Visual</a>>& </td>
<td class="paramname"> <em>visual</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>allocate</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="abb71a757b4f69a90d0fca884a6b4c62"></a><!-- doxytag: member="Gdk::Colormap::free_color" ref="abb71a757b4f69a90d0fca884a6b4c62" args="(Color &color)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gdk::Colormap::free_color </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGdk_1_1Color.html">Color</a>& </td>
<td class="paramname"> <em>color</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="79d4fec03cb95c71b64d4a0bc6282fe6"></a><!-- doxytag: member="Gdk::Colormap::free_colors" ref="79d4fec03cb95c71b64d4a0bc6282fe6" args="(Color &colors, int ncolors)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gdk::Colormap::free_colors </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGdk_1_1Color.html">Color</a>& </td>
<td class="paramname"> <em>colors</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>ncolors</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000003">Deprecated:</a></b></dt><dd>Use <a class="el" href="classGdk_1_1Colormap.html#abb71a757b4f69a90d0fca884a6b4c62">free_color()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="1d845482061a428a5b82b478cfb83cbd"></a><!-- doxytag: member="Gdk::Colormap::get_screen" ref="1d845482061a428a5b82b478cfb83cbd" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classGdk_1_1Screen.html">Screen</a>> Gdk::Colormap::get_screen </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the screen for which this colormap was created.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The screen for which this colormap was created.</dd></dl>
<dl compact><dt><b><a class="el" href="newin2p2s.html#_newin2p2s000002">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
</div>
</div><p>
<a class="anchor" name="0de4faa551cfccf109947e9af4dee7ff"></a><!-- doxytag: member="Gdk::Colormap::get_screen" ref="0de4faa551cfccf109947e9af4dee7ff" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Screen.html">Screen</a>> Gdk::Colormap::get_screen </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the screen for which this colormap was created.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The screen for which this colormap was created.</dd></dl>
<dl compact><dt><b><a class="el" href="newin2p2s.html#_newin2p2s000001">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
</div>
</div><p>
<a class="anchor" name="78c9dfeafac5833684299e8b1b5ce016"></a><!-- doxytag: member="Gdk::Colormap::get_system" ref="78c9dfeafac5833684299e8b1b5ce016" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Colormap.html">Colormap</a>> Gdk::Colormap::get_system </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the system's default colormap for the default screen.
<p>
(See gdk_colormap_get_system_for_screen()) <dl class="return" compact><dt><b>Returns:</b></dt><dd>The default colormap. </dd></dl>
</div>
</div><p>
<a class="anchor" name="45ed1e6f405f7aa1d0d60b2d878c1c43"></a><!-- doxytag: member="Gdk::Colormap::get_visual" ref="45ed1e6f405f7aa1d0d60b2d878c1c43" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classGdk_1_1Visual.html">Visual</a>> Gdk::Colormap::get_visual </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return value: the visual of the colormap.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The visual of the colormap. </dd></dl>
</div>
</div><p>
<a class="anchor" name="90d5e438d78992e2030832a196ac222b"></a><!-- doxytag: member="Gdk::Colormap::get_visual" ref="90d5e438d78992e2030832a196ac222b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Visual.html">Visual</a>> Gdk::Colormap::get_visual </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return value: the visual of the colormap.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The visual of the colormap. </dd></dl>
</div>
</div><p>
<a class="anchor" name="b13d6b3f34ac026eef002c2788839f4b"></a><!-- doxytag: member="Gdk::Colormap::gobj" ref="b13d6b3f34ac026eef002c2788839f4b" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GdkColormap* Gdk::Colormap::gobj </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C GObject.
<p>
<p>
Reimplemented from <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ObjectBase.html#2b7010748d60e770e9e0b3d65c100cf2">Glib::ObjectBase</a>.
</div>
</div><p>
<a class="anchor" name="8e073a91f54ca4f7443db9e1d514bb52"></a><!-- doxytag: member="Gdk::Colormap::gobj" ref="8e073a91f54ca4f7443db9e1d514bb52" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GdkColormap* Gdk::Colormap::gobj </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C GObject.
<p>
<p>
Reimplemented from <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ObjectBase.html#4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>.
</div>
</div><p>
<a class="anchor" name="8bc022fb6ea4673159155bca8e730a39"></a><!-- doxytag: member="Gdk::Colormap::gobj_copy" ref="8bc022fb6ea4673159155bca8e730a39" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GdkColormap* Gdk::Colormap::gobj_copy </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
<p>
</div>
</div><p>
<a class="anchor" name="c3c3335c6f0ceab1ab75d3f9bd25f53f"></a><!-- doxytag: member="Gdk::Colormap::query_color" ref="c3c3335c6f0ceab1ab75d3f9bd25f53f" args="(gulong pixel, Color &result)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gdk::Colormap::query_color </td>
<td>(</td>
<td class="paramtype">gulong </td>
<td class="paramname"> <em>pixel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classGdk_1_1Color.html">Color</a>& </td>
<td class="paramname"> <em>result</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Locates the RGB color in <em>colormap</em> corresponding to the given hardware pixel <em>pixel</em> .
<p>
<em>pixel</em> 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 <a class="el" href="classGdk_1_1Colormap.html#572fe8fade77afbdcc7f7cf56ff489f6">alloc_colors()</a>, or from a <a class="el" href="classGdk_1_1Image.html">Gdk::Image</a>. (A <a class="el" href="classGdk_1_1Image.html">Gdk::Image</a> contains image data in hardware format, a <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> contains image data in a canonical 24-bit RGB format.)<p>
This function is rarely useful; it's used for example to implement the eyedropper feature in <a class="el" href="classGtk_1_1ColorSelection.html">Gtk::ColorSelection</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pixel</em> </td><td>Pixel value in hardware display format. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td><a class="el" href="classGdk_1_1Color.html">Gdk::Color</a> with red, green, blue fields initialized. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="73e55bc63cbc380d36c3d382a47be80a"></a><!-- doxytag: member="Gdk::Colormap::wrap" ref="73e55bc63cbc380d36c3d382a47be80a" args="(GdkColormap *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Colormap.html">Gdk::Colormap</a>> wrap </td>
<td>(</td>
<td class="paramtype">GdkColormap * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="colormap_8h.html">colormap.h</a></ul>
</div>
<!-- end main content -->
<hr><address><small>
Generated for gtkmm 2.4 by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.5.1 © 1997-2001</small></address>
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
9411cff4bc6d4e61b29ae81cd24665af
>
files
>
129
