<html>
<head>
<link rel="stylesheet" href="page.css" type="text/css">
<title>fox-toolkit.org - Documentation</title>
</head>
<body bgcolor=#ffffff link=#990033 vlink=#990033 alink=#990033 text=#000000>
<font face='verdana,sans-serif' size=2 >
<!---- TOPIC TITLE WITH LOGO--->
<table border=0 cellpadding= cellspacing=2 width=100% ><tr><td><a href='http://www.fox-toolkit.org/doc.html'><img src='../art/foxlogo_small.jpg' border=0></a></td><td width=100% valign=bottom><font face='verdana,sans-serif' size=2 ><b>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a>
<br><img src='../art/line.gif' width=100% height=1></b></font></td></tr></table>
<p>
<!--- TOPIC TITLE WITH LOGO --->
<!-- Generated by Doxygen 1.3.3 -->
<h1>FXIcon.h</h1><div class="fragment"><pre>00001 <span class="comment">/********************************************************************************</span>
00002 <span class="comment">* *</span>
00003 <span class="comment">* I c o n - O b j e c t *</span>
00004 <span class="comment">* *</span>
00005 <span class="comment">*********************************************************************************</span>
00006 <span class="comment">* Copyright (C) 1997,2004 by Jeroen van der Zijp. All Rights Reserved. *</span>
00007 <span class="comment">*********************************************************************************</span>
00008 <span class="comment">* This library is free software; you can redistribute it and/or *</span>
00009 <span class="comment">* modify it under the terms of the GNU Lesser General Public *</span>
00010 <span class="comment">* License as published by the Free Software Foundation; either *</span>
00011 <span class="comment">* version 2.1 of the License, or (at your option) any later version. *</span>
00012 <span class="comment">* *</span>
00013 <span class="comment">* This library is distributed in the hope that it will be useful, *</span>
00014 <span class="comment">* but WITHOUT ANY WARRANTY; without even the implied warranty of *</span>
00015 <span class="comment">* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *</span>
00016 <span class="comment">* Lesser General Public License for more details. *</span>
00017 <span class="comment">* *</span>
00018 <span class="comment">* You should have received a copy of the GNU Lesser General Public *</span>
00019 <span class="comment">* License along with this library; if not, write to the Free Software *</span>
00020 <span class="comment">* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. *</span>
00021 <span class="comment">*********************************************************************************</span>
00022 <span class="comment">* $Id: FXIcon.h,v 1.25 2004/02/08 17:17:33 fox Exp $ *</span>
00023 <span class="comment">********************************************************************************/</span>
00024 <span class="preprocessor">#ifndef FXICON_H</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define FXICON_H</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#ifndef FXIMAGE_H</span>
00028 <span class="preprocessor"></span><span class="preprocessor">#include "FXImage.h"</span>
00029 <span class="preprocessor">#endif</span>
00030 <span class="preprocessor"></span>
00031 <span class="keyword">namespace </span>FX {
00032
00033 <span class="keyword">class </span>FXDC;
00034 <span class="keyword">class </span>FXDCWindow;
00035 <span class="keyword">class </span>FXDrawable;
00036 <span class="keyword">class </span>FXTopWindow;
00037
00038 <span class="comment"></span>
00039 <span class="comment">/**</span>
00040 <span class="comment">* An Icon is an image with two additional server-side resources: a shape</span>
00041 <span class="comment">* bitmap, which is used to mask those pixels where the background should</span>
00042 <span class="comment">* be preserved during the drawing, and a etch bitmap, which is used to</span>
00043 <span class="comment">* draw the icon when it is disabled.</span>
00044 <span class="comment">*/</span>
<a name="l00045"></a><a class="code" href="classFX_1_1FXIcon.html">00045</a> <span class="keyword">class </span>FXAPI FXIcon : <span class="keyword">public</span> <a class="code" href="classFX_1_1FXImage.html">FXImage</a> {
00046 FXDECLARE(FXIcon)
00047 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classFX_1_1FXDC.html">FXDC</a>;
00048 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classFX_1_1FXDCWindow.html">FXDCWindow</a>;
00049 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classFX_1_1FXDrawable.html">FXDrawable</a>;
00050 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classFX_1_1FXTopWindow.html">FXTopWindow</a>;
00051 <span class="keyword">protected</span>:
00052 FXID shape; <span class="comment">// Shape pixmap</span>
00053 FXID etch; <span class="comment">// Etch pixmap</span>
00054 FXColor transp; <span class="comment">// Transparency color</span>
00055 <span class="keyword">protected</span>:
00056 FXIcon(){}
00057 FXColor guesstransp();
00058 <span class="keyword">private</span>:
00059 FXIcon(<span class="keyword">const</span> FXIcon&);
00060 FXIcon &operator=(<span class="keyword">const</span> FXIcon&);
00061 <span class="keyword">public</span>:
00062 <span class="comment"></span>
00063 <span class="comment"> /**</span>
00064 <span class="comment"> * Create an icon with an initial pixel buffer pix, a transparent color clr,</span>
00065 <span class="comment"> * and options as in FXImage. The transparent color is used to determine which</span>
00066 <span class="comment"> * pixel values are transparent, i.e. need to be masked out in the absence of</span>
00067 <span class="comment"> * a true alpha channel.</span>
00068 <span class="comment"> * If the flag IMAGE_OPAQUE is passed, the shape and etch bitmaps are generated</span>
00069 <span class="comment"> * as if the image is fully opaque, even if it has an alpha channel or transparancy</span>
00070 <span class="comment"> * color. The flag IMAGE_ALPHACOLOR is used to force a specific alpha color instead</span>
00071 <span class="comment"> * of the alpha channel obtained from the image file.</span>
00072 <span class="comment"> * Specifying IMAGE_ALPHAGUESS causes Icon to obtain the alpha color from the background</span>
00073 <span class="comment"> * color of the image; it has the same effect as IMAGE_ALPHACOLOR in the sense that</span>
00074 <span class="comment"> * the icon will be transparent for those colors matching the alpha color.</span>
00075 <span class="comment"> */</span>
00076 FXIcon(<a class="code" href="classFX_1_1FXApp.html">FXApp</a>* a,<span class="keyword">const</span> FXColor *pix=NULL,FXColor clr=0,FXuint opts=0,FXint w=1,FXint h=1);
00077 <span class="comment"></span>
00078 <span class="comment"> /**</span>
00079 <span class="comment"> * Create the server side pixmap, the shape bitmap, and the etch bitmap, then</span>
00080 <span class="comment"> * call render() to fill it with the pixel data from the client-side buffer. After the server-</span>
00081 <span class="comment"> * side pixmap and bitmaps have been created, the client-side pixel buffer will be deleted unless</span>
00082 <span class="comment"> * IMAGE_KEEP has been specified. If the pixel buffer is not owned, i.e. the flag IMAGE_OWNED</span>
00083 <span class="comment"> * is not set, the pixel buffer will not be deleted.</span>
00084 <span class="comment"> */</span>
00085 <span class="keyword">virtual</span> <span class="keywordtype">void</span> create();
00086 <span class="comment"></span>
00087 <span class="comment"> /**</span>
00088 <span class="comment"> * Detach the server side pixmap, shape bitmap, and etch bitmap from the Icon.</span>
00089 <span class="comment"> * Afterwards, the Icon is left as if it never had a server-side resources.</span>
00090 <span class="comment"> */</span>
00091 <span class="keyword">virtual</span> <span class="keywordtype">void</span> detach();
00092 <span class="comment"></span>
00093 <span class="comment"> /**</span>
00094 <span class="comment"> * Destroy the server-side pixmap and the shape bitmap and etch bitmap.</span>
00095 <span class="comment"> * The client-side pixel buffer is not affected.</span>
00096 <span class="comment"> */</span>
00097 <span class="keyword">virtual</span> <span class="keywordtype">void</span> destroy();
00098 <span class="comment"></span>
00099 <span class="comment"> /**</span>
00100 <span class="comment"> * Render the server-side pixmap, shape bitmap and etch bitmap for the icon</span>
00101 <span class="comment"> * from the client-side pixel buffer.</span>
00102 <span class="comment"> */</span>
<a name="l00103"></a><a class="code" href="classFX_1_1FXIcon.html#a6">00103</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> render();
00104 <span class="comment"></span>
00105 <span class="comment"> /**</span>
<a name="l00106"></a><a class="code" href="classFX_1_1FXIcon.html#a7">00106</a> <span class="comment"> * Resize both client-side and server-side representations (if any) to the</span>
00107 <span class="comment"> * given width and height. The new representations typically contain garbage</span>
00108 <span class="comment"> * after this operation and need to be re-filled.</span>
00109 <span class="comment"> */</span>
00110 <span class="keyword">virtual</span> <span class="keywordtype">void</span> resize(FXint w,FXint h);
00111 <span class="comment"></span>
00112 <span class="comment"> /// Obtain transparency color</span>
00113 <span class="comment"></span> FXColor getTransparentColor()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> transp; }
00114 <span class="comment"></span>
00115 <span class="comment"> /// Change transparency color</span>
00116 <span class="comment"></span> <span class="keywordtype">void</span> setTransparentColor(FXColor color){ transp=color; }
00117 <span class="comment"></span>
00118 <span class="comment"> /// Destructor</span>
00119 <span class="comment"></span> <span class="keyword">virtual</span> ~FXIcon();
00120 };
00121
00122 }
00123
00124 <span class="preprocessor">#endif</span>
</pre></div></font>
<!--- COPYRIGHT -->
<p>
<table width=100% cellpadding=0 cellspacing=0><tr><td width=100% valign=top id=HEADLINE align=right>
<img src='../art/line.gif' width=100% height=1><font size=-1>
Copyright © 1997-2004 Jeroen van der Zijp</font>
</td></tr></table>
</p>
<!--- COPYRIGHT -->
</body>
</html>
