<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>FXCursor.h</h1><div class="fragment"><pre>00001 <span class="comment">/********************************************************************************</span> 00002 <span class="comment">* *</span> 00003 <span class="comment">* C u r s o r - 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: FXCursor.h,v 1.22 2004/01/14 06:26:10 fox Exp $ *</span> 00023 <span class="comment">********************************************************************************/</span> 00024 <span class="preprocessor">#ifndef FXCURSOR_H</span> 00025 <span class="preprocessor"></span><span class="preprocessor">#define FXCURSOR_H</span> 00026 <span class="preprocessor"></span> 00027 <span class="preprocessor">#ifndef FXID_H</span> 00028 <span class="preprocessor"></span><span class="preprocessor">#include "FXId.h"</span> 00029 <span class="preprocessor">#endif</span> 00030 <span class="preprocessor"></span> 00031 <span class="keyword">namespace </span>FX { 00032 00033 00034 <span class="comment">// Stock cursors</span> 00035 <span class="keyword">enum</span> <a class="code" href="group__FXCursor__0.html#a0">FXStockCursor</a> { 00036 <a class="code" href="group__FXCursor__0.html#a0a78">CURSOR_ARROW</a>=1, <span class="comment">/// Default left pointing arrow</span> 00037 <span class="comment"></span> <a class="code" href="group__FXCursor__0.html#a0a79">CURSOR_RARROW</a>, <span class="comment">/// Right arrow</span> <a name="l00038"></a><a class="code" href="group__FXCursor__0.html#a0">00038</a> <span class="comment"></span> <a class="code" href="group__FXCursor__0.html#a0a80">CURSOR_IBEAM</a>, <span class="comment">/// Text I-Beam</span> 00039 <span class="comment"></span> <a class="code" href="group__FXCursor__0.html#a0a81">CURSOR_WATCH</a>, <span class="comment">/// Stopwatch or hourglass</span> 00040 <span class="comment"></span> <a class="code" href="group__FXCursor__0.html#a0a82">CURSOR_CROSS</a>, <span class="comment">/// Crosshair</span> 00041 <span class="comment"></span> <a class="code" href="group__FXCursor__0.html#a0a83">CURSOR_UPDOWN</a>, <span class="comment">/// Move up, down</span> 00042 <span class="comment"></span> <a class="code" href="group__FXCursor__0.html#a0a84">CURSOR_LEFTRIGHT</a>, <span class="comment">/// Move left, right</span> 00043 <span class="comment"></span> <a class="code" href="group__FXCursor__0.html#a0a85">CURSOR_MOVE</a> <span class="comment">/// Move up,down,left,right</span> 00044 <span class="comment"></span> }; 00045 00046 <span class="comment"></span> 00047 <span class="comment">/// Cursor options</span> 00048 <span class="comment"></span><span class="keyword">enum</span> { 00049 <a class="code" href="group__FXCursor__1.html#a0a86">CURSOR_KEEP</a> = 0x00000100, <span class="comment">/// Keep pixel data in client</span> 00050 <span class="comment"></span> <a class="code" href="group__FXCursor__1.html#a0a87">CURSOR_OWNED</a> = 0x00000200 <span class="comment">/// Pixel data is owned by image</span> 00051 <span class="comment"></span> }; 00052 00053 <span class="comment"></span> 00054 <span class="comment">/// Cursor class</span> 00055 <span class="comment"></span><span class="keyword">class </span>FXAPI FXCursor : <span class="keyword">public</span> FXId { 00056 FXDECLARE(FXCursor) 00057 <span class="keyword">protected</span>: 00058 FXColor *data; <span class="comment">// Source data</span> 00059 FXint width; <span class="comment">// Width</span> 00060 FXint height; <span class="comment">// Height</span> 00061 FXint hotx; <span class="comment">// Hot spot x</span> 00062 FXint hoty; <span class="comment">// Hot spot y</span> 00063 FXuint options; <span class="comment">// Options</span> 00064 <span class="keyword">protected</span>: 00065 FXCursor(); 00066 <span class="keyword">private</span>: 00067 FXCursor(<span class="keyword">const</span> FXCursor&); <a name="l00068"></a><a class="code" href="classFX_1_1FXCursor.html">00068</a> FXCursor &operator=(<span class="keyword">const</span> FXCursor&); 00069 <span class="keyword">public</span>: 00070 <span class="comment"></span> 00071 <span class="comment"> /// Make stock cursor</span> 00072 <span class="comment"></span> FXCursor(<a class="code" href="classFX_1_1FXApp.html">FXApp</a>* a,FXStockCursor curid=CURSOR_ARROW); 00073 <span class="comment"></span> 00074 <span class="comment"> /// Make cursor from source and mask; cursor size should at most 32x32 for portability!</span> 00075 <span class="comment"></span> FXCursor(<a class="code" href="classFX_1_1FXApp.html">FXApp</a>* a,<span class="keyword">const</span> FXuchar* src,<span class="keyword">const</span> FXuchar* msk,FXint w=32,FXint h=32,FXint hx=0,FXint hy=0); 00076 <span class="comment"></span> 00077 <span class="comment"> /// Make cursor from FXColor pixels; cursor size should be at most 32x32 for portability!</span> 00078 <span class="comment"></span> FXCursor(<a class="code" href="classFX_1_1FXApp.html">FXApp</a>* a,<span class="keyword">const</span> FXColor* pix,FXint w=32,FXint h=32,FXint hx=0,FXint hy=0); 00079 <span class="comment"></span> 00080 <span class="comment"> /// Width of cursor; returns 0 for stock cursors</span> 00081 <span class="comment"></span> FXint getWidth()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> width; } <a name="l00082"></a><a class="code" href="classFX_1_1FXCursor.html#a3">00082</a> <span class="comment"></span> 00083 <span class="comment"> /// Height or cursor; returns 0 for stock cursors</span> 00084 <span class="comment"></span> FXint getHeight()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> height; } <a name="l00085"></a><a class="code" href="classFX_1_1FXCursor.html#a4">00085</a> <span class="comment"></span> 00086 <span class="comment"> /// Get hotspot x; returns 0 for stock cursors</span> 00087 <span class="comment"></span> FXint getHotX()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> hotx; } <a name="l00088"></a><a class="code" href="classFX_1_1FXCursor.html#a5">00088</a> <span class="comment"></span> 00089 <span class="comment"> /// Get hotspot y; returns 0 for stock cursors</span> 00090 <span class="comment"></span> FXint getHotY()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> hoty; } <a name="l00091"></a><a class="code" href="classFX_1_1FXCursor.html#a6">00091</a> <span class="comment"></span> 00092 <span class="comment"> /// Check if there is color in the cursor</span> 00093 <span class="comment"></span> FXbool isColor() <span class="keyword">const</span>; 00094 <span class="comment"></span> 00095 <span class="comment"> /// Create cursor</span> 00096 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> create(); 00097 <span class="comment"></span> 00098 <span class="comment"> /// Detach cursor</span> 00099 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> detach(); 00100 <span class="comment"></span> 00101 <span class="comment"> /// Destroy cursor</span> 00102 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> destroy(); 00103 <span class="comment"></span> 00104 <span class="comment"> /// Release pixels buffer if it was owned</span> 00105 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> release(); 00106 <span class="comment"></span> 00107 <span class="comment"> /// Save pixel data only</span> 00108 <span class="comment"></span> <span class="keyword">virtual</span> FXbool savePixels(<a class="code" href="classFX_1_1FXStream.html">FXStream</a>& store) <span class="keyword">const</span>; 00109 <span class="comment"></span> 00110 <span class="comment"> /// Load pixel data only</span> 00111 <span class="comment"></span> <span class="keyword">virtual</span> FXbool loadPixels(<a class="code" href="classFX_1_1FXStream.html">FXStream</a>& store); 00112 <span class="comment"></span> 00113 <span class="comment"> /// Save cursor to a stream</span> 00114 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> save(<a class="code" href="classFX_1_1FXStream.html">FXStream</a>& store) <span class="keyword">const</span>; 00115 <span class="comment"></span> 00116 <span class="comment"> /// Load cursor from a stream</span> 00117 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> load(<a class="code" href="classFX_1_1FXStream.html">FXStream</a>& store); 00118 <span class="comment"></span> 00119 <span class="comment"> /// Destructor</span> 00120 <span class="comment"></span> <span class="keyword">virtual</span> ~FXCursor(); 00121 }; 00122 00123 } 00124 00125 <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>