TweetFollow Us on Twitter

Cursor Control 1
Volume Number:6
Issue Number:6
Column Tag:abC

Related Info: TextEdit Quickdraw

Cursor Control

By Bob Gordon, Minneapolis, MN

Note: Source code files accompanying article are located on MacTech CD-ROM or source code disks.

Managing Cursors

I know how to curse

Shakespeare, The Tempest (Act 1, Scene 2)

If you remember from last time, I had introduced the idea of adding some additional data structures at the end of the window record to aid in keeping track of the data that hangs around with a window. At the end of that article I said we would illustrate the use of the added data in managing the cursor. We will cover that, but first I would like to comment on a nice piece of work by John Nairn in the April issue.

John has presented a full-blown Scrolling Manager to handle all the issues involved with creating and maintaining scrolling windows. While there are a number of differences between what he has done and what I am describing in this column, a couple common points are worth mentioning. First, the approach is to isolate the user interface control from the actual application. That is, as much as possible, develop generic code to handle the basic operation of the windows (or menus or dialogs, for that matter). Second, this generic code will probably require some place to keep the information it uses; develop a data structure to hold this, and attach it in some way to the window (or menu or dialog). There is actually a bit more commonality (I have the advantage of being able to see the parts I have written but not yet published), and we will explore one of those in this article.

One point of difference. John uses the window’s refCon to hold his additional data structure. His new data structure includes its own refCon for the window’s contents. I added the data on to the end of the window’s structure itself. I feel this simplifies things somewhat, and at least for now it does not seem to violate any rules. If you liked John’s article as I did, you certainly have my permission to use the technique I’ve outlined in implementing it. While I haven’t met John, I’m reasonably sure he won’t mind.

Cursors

The cursor attached to the mouse changes its shape as you move the mouse around the screen. In addition, the user can often affect its shape directly by selecting a tool from a toolbox (usually found in graphics or page layout applications). The problem we deal with this month is how to manage the cursor so it is handled as automatically as possible.

The first issue is getting cursors. There are five built in to the Mac: arrow, crosshairs, plus, clock, i-beam. You can also make your own with ResEdit or some other resource tool. Once we have decided the cursors to use (and made their resources), we need to control the appearance on the screen. What I will describe this month is one way to manage the change of cursor shape as the user moves the mouse around the screen. I am not covering the setting of the cursor’s via tool box or menus.

In June I suggested the use of window margins. The window margin is that area between the window’s frame, which is handled by the Macintosh toolbox routines, and the window’s actual contents, which is what your application is about. The objects that might be in a window margin include scroll bars, rulers, and tool boxes. These are such common components of windows that they can be handled by generic code apart from your application. The other property of the window margin is that the cursor typically changes into the arrow as it is moved into the scroll bar, ruler, etc.

Cursorhelp

Cursorhelp consists of three functions and an include file to aid in the setting and automatic changing of cursors. These functions assume the window structure described in June. The window margins (mtop,mbottom, mright, mleft) are stored with the window. More importantly, the rectangle that surrounds the actual window contents (cursrt) is also stored (I assume rectangular windows). This rectangle is the area in which the cursor is the shape the user selected (i beam, cross, etc.). I put it in the window structure simply to avoid having to calculate it each time. The final piece is the cursor itself (mouser). That is, the cursor’s shape as selected by the user is a property of the window. With a multi-window application the user can have one window editing text, another editing a graphic, and a third editing a spreadsheet (I am not suggesting anyone actually write something like this), and the appropriate cursor will be displayed automatically as the user selects each window. The main loop need know nothing of the cursors.

The main loop does need to set the cursor. There are two places where this can occur: the users specifies a cursor in some way or, the application displays the watch (or other indicator) to indicate the passage of time. The program calls CursorToUse passing the window and the number of the desired cursor.

The program also needs to set the cursor rectangle. This must be done every time the window’s size is changed or the window margins are changed (for example, choosing to show rulers or not).A call to CursorRect() does that. Note that the window margins must have been previously set.

To actually control the cursor, the program calls CursorMaintain() as it runs through the event loop.

Include Files
/*windowhelp.h */
#include “TextEdit.h”
 
#ifndef WINDOWHELP_H
#define WINDOWHELP_H
#include“abc.h”    /* window add-on structure */

#define WindowStruct struct w_struct
WindowStruct
 {
 WindowRecord  wr;  /* the original window record */
 uchar  mtop;    /* margin indents */
 uchar  mleft;
 uchar  mbottom;
 uchar  mright;
 Rect   cursrt;    /* used for cursor control */
 char   mouser;  /* mouse pointer id  */
 char   changed; /* if contents were changed */
 long   ckind;   /* kind of contents */
 short  fileref; /* associated file, if any */
 TEHandle curtext; /* handle to current text */
 };
 
WindowStruct*WindowNew();

#define Woffset  18
#define SBarWidth 15

/* these definitions allow easy generation of the four square cornered 
titled windows. The basic (simplest) window is the WDOC (NoGrowDocProc). 
To this optionally add WGROW to add a grow box and/or WZOOM to add a 
zoom box.
 */
#define WDOC4
#define WGROW    -4
#define WZOOM    8
#define WVBAR    16
#define WHBAR    32

/* Value placed in windowKind field of WindowRecord by WindowNew if the 
window has a grow box. This is used by routines that redraw the window 
to decide whether to draw the grow box or not 
 */
#define HASGROW  9

#endif

/* cursorhelp.h
 * header file for cursorhelp
 */
 
 #defineARROW  0
 #defineIBEAM  1
 #defineCROSS  2
 #definePLUS3
 #defineWATCH  4
CursorHelp Functions
#include“abc.h”
#include“Quickdraw.h”
#include“windowMgr.h”
#include“windowhelp.h”
#include“cursorhelp.h”

/* CursorMaintain
 * Adjusts the cursor according to the value
 * set in the window and the rectangle currect.
 * If the mouse is in the rectangle, the cursor 
 * set to the current cursor, otherwise it is
 * set to the arrow.
 * The if statement checks to see if there is a 
 * valid window and if the window belongs to the
 * application. If it does not belong to the application
 * it is a DA. If the DA is controlling the cursor, there
 * will be a conflict as both programs attempt to control
 * it.
 */
CursorMaintain(ws)
 WindowStruct  *ws;
{
 Point  pt;
 CursHandle curs;
 short  curcursor; /* current cursor */
 
 if (ws && (((WindowRecord *)ws)->windowKind > 7) )
 {
 GetMouse(&pt);
 curcursor = ws->mouser;  /* cursor kind is stored in the window struct 
*/
 if ((PtInRect(pt, &(ws->cursrt))) && (curcursor))
 {
 curs = (Cursor **)GetCursor(curcursor);     
 SetCursor(*curs); 
 }
 else if (curcursor != WATCH)
 {
 InitCursor();
 }
 }
 if (ws == NIL)
 InitCursor();
}

/* CursorRect
 * Uses the portRect of the window passed in
 * to set the current rectangle.  Adjusts the size
 * of the rectangle to account for window margins.
 * By keeping the rectangle around, we eliminate doing
 * this each time through the event loop.
 */
 
CursorRect(ws)
 WindowStruct    *ws;
{
 ws->cursrt = ((GrafPort *)ws)->portRect;
 AdjustRect(&(ws->cursrt),ws->mtop,ws->mleft,ws->mbottom,ws->mright);
}

/* CursorToUse
 * Sets the cursor to be displayed in the
 * rectangle of the current window.
 * Either pass a pointer to the window struct
 * or a NULL pointer. If a NULL pointer is passed,
 * CursorToUse() will use the front window. 
 * Note: At least one window must exist for this
 * to work, but if no windows exist, it
 * will not hurt.
 */
CursorToUse(ws,c)
 WindowStruct  *ws;/* window struct to set cursor for */
 short  c;/* cursor code to use */
{
 if (!ws)
 ws = (WindowStruct *)FrontWindow();
 if (ws)
 ws->mouser = c;
}

Using CursorMaintain()

The following fragment shows the call to CursorMaintain() in the main event loop.

EventLoop()
{
 EventRecordtheEvent;
 char   c;
 short  windowcode;
 WindowPtrwp;
 WindowStruct  *ws;
 
 while(True)
 {
 wp = FrontWindow();
 SystemTask();
 CursorMaintain(wp); 
 if (wp)
 {
 AppTask(wp);
 } 
 if (GetNextEvent(everyEvent,&theEvent))
 switch(theEvent.what)

Other Comments

Check John Nairn’s article for other things to do to automate cursor control. You will note he checks for certain keys being pressed to change the cursor to allow window scrolling (e.g. with a hand).

Last Time

I have a minor error in June’s column. I included some space in the window structure to handle window zooming. These are not needed as zooming is fully supported by the Mac Toolbox. I hadn’t used them for anything yet.

Next Time

Next time I am going to show a quick and very dirty way to help deal with menus.

P.S. Comments are welcome. Send your notes to MacTutor, and please include a phone number.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

LooperSonic (Music)
LooperSonic 1.0 Device: iOS Universal Category: Music Price: $4.99, Version: 1.0 (iTunes) Description: LooperSonic is a multi-track audio looper and recorder that will take your loops to the next level. Use it like a loop pedal to... | Read more »
Space Grunts guide - How to survive
Space Grunts is a fast-paced roguelike from popular iOS developer, Orange Pixel. While it taps into many of the typical roguelike sensibilities, you might still find yourself caught out by a few things. We delved further to find you some helpful... | Read more »
Dreii guide - How to play well with othe...
Dreii is a rather stylish and wonderful puzzle game that’s reminiscent of cooperative games like Journey. If that sounds immensely appealing, then you should immediately get cracking and give it a whirl. We can offer you some tips and tricks on... | Read more »
Kill the Plumber World guide - How to ou...
You already know how to hop around like Mario, but do you know how to defeat him? Those are your marching orders in Kill the Plumber, and it's not always as easy as it looks. Here are some tips to get you started. This is not a seasoned platform... | Read more »
Planar Conquest (Games)
Planar Conquest 1.0 Device: iOS Universal Category: Games Price: $12.99, Version: 1.0 (iTunes) Description: IMPORTANT: Planar Conquest is compatible only with iPad 3 & newer devices, iPhone 5 & newer. It’s NOT compatible with... | Read more »
We talk to Cheetah Mobile about its plan...
Piano Tiles 2 is a fast-paced rhythm action high score chaser out now on iOS and Android. You have to tap a series of black tiles that appear on the screen in time to the music, being careful not to accidentally hit anywhere else. Do that and it's... | Read more »
Ultimate Briefcase guide - How to dodge...
Ultimate Briefcase is a simple but tricky game that’s highly dependent on how fast you can react. We can still offer you a few tips and tricks on how to survive though. Guess what? That’s exactly what we’re going to do now. Take it easy [Read more... | Read more »
SoundPrism Link Edition (Music)
SoundPrism Link Edition 1.0 Device: iOS Universal Category: Music Price: $4.99, Version: 1.0 (iTunes) Description: ***Introductory price for a the first few days after launch - if you're reading this, get it while it's fresh out of... | Read more »
Pre-register now for hack and slasher An...
Fincon, which won Facebook's Studio to Watch award in 2015, has announced that pre-registration is now open for the massive 3.0 update for its award-winning hack and slasher Angel Stone. Angel Stone is a post-apocalyptic action RPG in which the... | Read more »
Google has named Piano Tiles 2 as its Be...
Google has named Piano Tiles 2, which launched back in August last year, as its Best Game of 2015. If you're yet to play it, now's a good time to do so. It's a sequel to the hugely successful viral hit Piano Tiles (Don't Tap the White Tile) but... | Read more »

Price Scanner via MacPrices.net

Apple refurbished 2014 13-inch Retina MacBook...
Apple has Certified Refurbished 2014 13″ Retina MacBook Pros available for up to $400 off original MSRP, starting at $979. An Apple one-year warranty is included with each model, and shipping is free... Read more
Macs available for up to $300 off MSRP, $20 o...
Purchase a new Mac or iPad using Apple’s Education Store and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free, and... Read more
Watch Super Bowl 50 Live On Your iPad For Fre...
Watch Super Bowl 50 LIVE on the CBS Sports app for iPad and Apple TV. Get the app and then tune in Sunday, February 7, 2016 at 6:30 PM ET to catch every moment of the big game. The CBS Sports app is... Read more
Two-thirds Of All Smart Watches Shipped In 20...
Apple dominated the smart watch market in 2015, accounting for over 12 million units and two-thirds of all shipments according to Canalys market research analysts’ estimates. Samsung returned to... Read more
12-inch 1.2GHz Retina MacBooks on sale for up...
B&H Photo has 12″ 1.2GHz Retina MacBooks on sale for $180 off MSRP. Shipping is free, and B&H charges NY tax only: - 12″ 1.2GHz Gray Retina MacBook: $1499 $100 off MSRP - 12″ 1.2GHz Silver... Read more
12-inch 1.1GHz Gray Retina MacBook on sale fo...
B&H Photo has the 12″ 1.1GHz Gray Retina MacBook on sale for $1199 including free shipping plus NY sales tax only. Their price is $100 off MSRP, and it’s the lowest price available for this model... Read more
Apple now offering full line of Certified Ref...
Apple now has a full line of Certified Refurbished 2015 21″ & 27″ iMacs available for up to $350 off MSRP. Apple’s one-year warranty is standard, and shipping is free. The following models are... Read more
Free GUI Speedometer – The Ultimate Digital D...
Miami, Florida based RMKapps has announced the official release of GUI Speedometer 1.0, their digital dashboard display developed for iOS devices. GUI Speedometer allows users to track their precise... Read more
FutureCalc: Ergonomic iOS Calculator App For...
London, United Kingdom based Independent software developer and entrepreneur, Hovik Melikyan has announced the release and immediate availability of FutureCalc 1.0, his new ergonomic calculator app... Read more
Save up to $600 with Apple refurbished Mac Pr...
Apple has Certified Refurbished Mac Pros available for up to $600 off the cost of new models. An Apple one-year warranty is included with each Mac Pro, and shipping is free. The following... Read more

Jobs Board

*Apple* Subject Matter Expert - Experis (Uni...
This position is for an Apple Subject Matter Expert to assist in developing the architecture, support and services for integration of Apple devices into the domain. Read more
*Apple* Macintosh OSX - Net2Source Inc. (Uni...
…: * Work Authorization : * Contact Number(Best time to reach you) : Skills : Apple Macintosh OSX Location : New York, New York. Duartion : 6+ Months The associate would Read more
Computer Operations Technician ll - *Apple*...
# Web Announcement** Apple Technical Liaison**The George Mason University, Information Technology Services (ITS), Technology Support Services, Desktop Support Read more
Restaurant Manager - Apple Gilroy Inc./Apple...
…in every aspect of daily operation. WHY YOU'LL LIKE IT: You'll be the Big Apple . You'll solve problems. You'll get to show your ability to handle the stress and Read more
Simply Mac *Apple* Specialist- Service Repa...
Simply Mac is the largest premier retailer of Apple products in the nation. In order to support our growing customer base, we are currently looking for a driven Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.