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.

 
AAPL
$100.96
Apple Inc.
-0.83
MSFT
$47.52
Microsoft Corpora
+0.84
GOOG
$596.08
Google Inc.
+6.81

MacTech Search:
Community Search:

Software Updates via MacUpdate

Airfoil 4.8.9 - Send audio from any app...
Airfoil allows you to send any audio to AirPort Express units, Apple TVs, and even other Macs and PCs, all in sync! It's your audio - everywhere. With Airfoil you can take audio from any... Read more
WhatRoute 1.13.0 - Geographically trace...
WhatRoute is designed to find the names of all the routers an IP packet passes through on its way from your Mac to a destination host. It also measures the round-trip time from your Mac to the... Read more
Chromium 37.0.2062.122 - Fast and stable...
Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all Internet users to experience the web. FreeSMUG-Free OpenSource Mac User Group build is... Read more
Attachment Tamer 3.1.14b9 - Take control...
Attachment Tamer gives you control over attachment handling in Apple Mail. It fixes the most annoying Apple Mail flaws, ensures compatibility with other email software, and allows you to set up how... Read more
Duplicate Annihilator 5.0 - Find and del...
Duplicate Annihilator takes on the time-consuming task of comparing the images in your iPhoto library using effective algorithms to make sure that no duplicate escapes. Duplicate Annihilator detects... Read more
jAlbum Pro 12.2 - Organize your digital...
jAlbum Pro has all the features you love in jAlbum, but comes with a commercial license. With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code!... Read more
jAlbum 12.2 - Create custom photo galler...
With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code! Beginner-friendly, with pro results Simply drag and drop photos into groups, choose a design... Read more
Quicken 2015 2.0.4 - Complete personal f...
Quicken 2015 helps you manage all your personal finances in one place, so you can see where you're spending and where you can save. Quicken automatically categorizes your financial transactions,... Read more
iMazing 1.0 - Complete iOS device manage...
iMazing (formerly DiskAid) is the ultimate iOS device manager with capabilities far beyond what iTunes offers. With iMazing and your iOS device (iPhone, iPad, or iPod), you can: Copy music to and... Read more
Xcode 6.0.1 - Integrated development env...
Apple Xcode is Apple Computer's integrated development environment (IDE) for OS X. The full Xcode package is free to ADC members and includes all the tools you need to create, debug, and optimize... Read more

Latest Forum Discussions

See All

View Source – HTML, JavaScript and CSS...
View Source – HTML, JavaScript and CSS 1.0 Device: iOS Universal Category: Utilities Price: $.99, Version: 1.0 (iTunes) Description: View Source is an app plus an iOS 8 Safari extension that makes it easy to do one key web developer... | Read more »
Avenged Sevenfold’s Hail To The King: De...
Avenged Sevenfold’s Hail To The King: Deathbat is Coming to iOS on October 16th Posted by Jessica Fisher on September 19th, 2014 [ permalink ] Just in time for Halloween, on October 16 Avenged Sevenfold will be launching | Read more »
Talisman Has Gone Universal – Can Now be...
Talisman Has Gone Universal – Can Now be Played on the iPhone Posted by Jessica Fisher on September 19th, 2014 [ permalink ] | Read more »
Tap Army Review
Tap Army Review By Jennifer Allen on September 19th, 2014 Our Rating: :: SHOOT EM ALLUniversal App - Designed for iPhone and iPad Mindless but fun, Tap Army is a lane-based shooter that should help you relieve some stress.   | Read more »
Monsters! Volcanoes! Loot! Epic Island f...
Monsters! Volcanoes! Loot! | Read more »
Plunder Pirates: Tips, Tricks, Strategie...
Ahoy There, Seadogs: Interested in knowing our thoughts on all this plundering and pirating? Check out our Plunder Pirates Review! Have you just downloaded the rather enjoyable pirate-em-up Plunder Pirates and are in need of some assistance? Never... | Read more »
Goat Simulator Review
Goat Simulator Review By Lee Hamlet on September 19th, 2014 Our Rating: :: THE GRUFFEST OF BILLY GOATSUniversal App - Designed for iPhone and iPad Unleash chaos as a grumpy goat in this humorous but short-lived casual game.   | Read more »
A New and Improved Wunderlist is Here fo...
A New and Improved Wunderlist is Here for iOS 8 Posted by Jessica Fisher on September 19th, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Evernote Update for iOS 8 Adds Web Clipp...
Evernote Update for iOS 8 Adds Web Clipping, Quick Notes, and More Posted by Ellis Spice on September 19th, 2014 [ permalink ] | Read more »
Apple Names Ultimate Productivity Bundl...
Apple Names Ultimate Productivity Bundle by Readdle as the Essential Bundle on the App Store Posted by Jessica Fisher on September 19th, 2014 [ permalink | Read more »

Price Scanner via MacPrices.net

Updated Price Trackers
We’ve updated our Mac Price Trackers with the latest information on prices, bundles, and availability on systems from Apple’s authorized internet/catalog resellers: - 15″ MacBook Pros - 13″ MacBook... Read more
Mac Pros available for up to $260 off MSRP
Adorama has Mac Pros on sale for up to $260 off MSRP. Shipping is free, and Adorama charges sales tax in NY & NJ only: - 4-core Mac Pro: $2839.99, $160 off MSRP - 6-core Mac Pro: $3739.99, $260... Read more
13-inch 2.6GHz/256GB Retina MacBook Pros avai...
B&H Photo has the 13″ 2.6GHz/256GB Retina MacBook Pro on sale for $1379 including free shipping plus NY sales tax only. Their price is $120 off MSRP. Read more
Previous-generation 15-inch 2.0GHz Retina Mac...
B&H Photo has leftover previous-generation 15″ 2.0GHz Retina MacBook Pros now available for $1599 including free shipping plus NY sales tax only. Their price is $400 off original MSRP. B&H... Read more
21″ 2.7GHz iMac available for $1179, save $12...
Adorama has 21″ 2.7GHz Hawell iMacs on sale for $1179.99 including free shipping. Their price is $120 off MSRP. NY and NJ sales tax only. Read more
iOS 8 Adoption Rate Slower than iOS 7, 6, Hit...
Apple began pushing out iOS 8 updates to eligible devices around 1pm ET on September 17, 2014. However, unlike with iOS 7, which boasted a wide variety of differences from its predecessor iOS 6, in... Read more
LIkely Final Definitive OS X 10.9.5 Mavericks...
Apple has released what will almost certainly be the last incremental version number update of OS X 10.9 Mavericks (save for futire security updates) before OS X 10.10 Yosemite is released next month... Read more
Fingerprints, Apple Pay and Identity Theft Wa...
On Sep 9th, CEO Tim Cook unveiled Apple Pay, along with the new iPhone 6 and iWatch. Apple Pay is a newly developed technology that utilizes a near field communication (NFC) to enable customer... Read more
Amazon Introduces Two All-New Kindles
Amazon on Thursday introduced the 7th generation of its Kindle dedicated e-reader device: Kindle Voyage, its top-of-the-line e-reader, and the new $79 Kindle, with a 20% faster processor, twice the... Read more
Save up to $300 on the price of a new Mac wit...
Purchase a new Mac or iPad at The Apple Store for Education and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free,... Read more

Jobs Board

*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
Project Manager, *Apple* Financial Services...
**Job Summary** Apple Financial Services (AFS) offers consumers, businesses and educational institutions ways to finance Apple purchases. We work with national and Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.