forked from cellularmitosis/ADC-reference-library-2009-july
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathlisting7.html
More file actions
executable file
·444 lines (380 loc) · 18.1 KB
/
Copy pathlisting7.html
File metadata and controls
executable file
·444 lines (380 loc) · 18.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<!-- BEGIN META TAG INFO -->
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="home" href="http://developer.apple.com/">
<link rel="find" href="http://developer.apple.com/search/">
<link rel="stylesheet" type="text/css" href="../../documentation/css/adcstyle.css" title="fonts">
<script language="JavaScript" src="../../documentation/js/adc.js" type="text/javascript"></script>
<!-- END META TAG INFO -->
<!-- BEGIN TITLE -->
<title>Custom_HIView_Tutorial - /0_Tutorial/Tracking.html</title>
<!-- END TITLE -->
<script language="JavaScript">
function JumpToNewPage() {
window.location=document.scpopupmenu.gotop.value;
return true;
}
</script>
</head>
<!-- BEGIN BODY OPEN -->
<body>
<!--END BODY OPEN -->
<!-- START CENTER OPEN -->
<center>
<!-- END CENTER OPEN -->
<!-- BEGIN LOGO AND SEARCH -->
<!--#include virtual="/includes/adcnavbar"-->
<!-- END LOGO AND SEARCH -->
<!-- START BREADCRUMB -->
<div id="breadcrumb">
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td scope="row"><img width="340" height="10" src="images/1dot.gif" alt=""></td>
<td><img width="340" height="10" src="images/1dot.gif" alt=""></td>
</tr>
<tr valign="middle">
<td align="left" colspan="2">
<a href="http://developer.apple.com/">ADC Home</a> > <a href="../../referencelibrary/index.html">Reference Library</a> > <a href="../../samplecode/index.html">Sample Code</a> > <a href="../../samplecode/Carbon/index.html">Carbon</a> > <a href="../../samplecode/Carbon/idxHumanInterfaceToolbox-date.html">Human Interface Toolbox</a> > <A HREF="javascript:location.replace('index.html');">Custom_HIView_Tutorial</A> >
</td>
</tr>
<tr>
<td colspan="2" scope="row"><img width="680" height="35" src="images/1dot.gif" alt=""></td>
</tr>
</table>
</div>
<!-- END BREADCRUMB -->
<!-- START MAIN CONTENT -->
<!-- START TITLE GRAPHIC AND INTRO-->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td><h1><div id="pagehead">Custom_HIView_Tutorial</div></h1></td>
</tr>
</table>
<!-- END TITLE GRAPHIC AND INTRO -->
<!-- START WIDE COLUMN -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td id="scdetails">
<h2>/0_Tutorial/Tracking.html</h2>
<form name="scpopupmenu" onSubmit="return false;" method=post>
<p><strong>View Source Code:</strong>
<select name="gotop" onChange="JumpToNewPage();" style="width:340px"><option selected value="ingnore">Select File</option>
<option value="listing1.html">/0_ Tutorial Start Here.html</option>
<option value="listing2.html">/0_Tutorial/Conclusion.html</option>
<option value="listing3.html">/0_Tutorial/Custom Cursor.html</option>
<option value="listing4.html">/0_Tutorial/Drag and Drop.html</option>
<option value="listing5.html">/0_Tutorial/Minimum Requirements.html</option>
<option value="listing6.html">/0_Tutorial/Skeleton Tester.html</option>
<option value="listing7.html">/0_Tutorial/Tracking.html</option>
<option value="listing8.html">/0_Tutorial/Value and State.html</option>
<option value="listing9.html">/1_Definition_Registration_Drawing/HICustomView.c</option>
<option value="listing10.html">/1_Definition_Registration_Drawing/HICustomView.h</option>
<option value="listing11.html">/1_Definition_Registration_Drawing/HICustomView_Tester.c</option>
<option value="listing12.html">/1_Definition_Registration_Drawing/HICustomView_Tester.h</option>
<option value="listing13.html">/1_Definition_Registration_Drawing/main.c</option>
<option value="listing14.html">/2_Value_State/HICustomView.c</option>
<option value="listing15.html">/2_Value_State/HICustomView.h</option>
<option value="listing16.html">/2_Value_State/HICustomView_Tester.c</option>
<option value="listing17.html">/2_Value_State/HICustomView_Tester.h</option>
<option value="listing18.html">/2_Value_State/main.c</option>
<option value="listing19.html">/3_Basic_Tracking/HICustomView.c</option>
<option value="listing20.html">/3_Basic_Tracking/HICustomView.h</option>
<option value="listing21.html">/3_Basic_Tracking/HICustomView_Tester.c</option>
<option value="listing22.html">/3_Basic_Tracking/HICustomView_Tester.h</option>
<option value="listing23.html">/3_Basic_Tracking/main.c</option>
<option value="listing24.html">/4_Custom_Tracking/HICustomView.c</option>
<option value="listing25.html">/4_Custom_Tracking/HICustomView.h</option>
<option value="listing26.html">/4_Custom_Tracking/HICustomView_Tester.c</option>
<option value="listing27.html">/4_Custom_Tracking/HICustomView_Tester.h</option>
<option value="listing28.html">/4_Custom_Tracking/main.c</option>
<option value="listing29.html">/5_Tracking_Area/HICustomView.c</option>
<option value="listing30.html">/5_Tracking_Area/HICustomView.h</option>
<option value="listing31.html">/5_Tracking_Area/HICustomView_Tester.c</option>
<option value="listing32.html">/5_Tracking_Area/HICustomView_Tester.h</option>
<option value="listing33.html">/5_Tracking_Area/main.c</option>
<option value="listing34.html">/6_Drag_and_Dropping/HICustomView.c</option>
<option value="listing35.html">/6_Drag_and_Dropping/HICustomView.h</option>
<option value="listing36.html">/6_Drag_and_Dropping/HICustomView_Tester.c</option>
<option value="listing37.html">/6_Drag_and_Dropping/HICustomView_Tester.h</option>
<option value="listing38.html">/6_Drag_and_Dropping/main.c</option></select>
</p>
</form>
<p><strong><a href="Custom_HIView_Tutorial.zip">Download Sample</a></strong> (“Custom_HIView_Tutorial.zip”, 1012.9K)<BR>
<strong><a href="Custom_HIView_Tutorial.dmg">Download Sample</a></strong> (“Custom_HIView_Tutorial.dmg”, 1.24M)</p>
<!--
<p><strong><a href="#">Download Sample</a></strong> (“filename.sit”, 500K)</p>
-->
</td>
</tr>
<tr>
<td scope="row"><img width="680" height="10" src="images/1dot.gif" alt=""><br>
<img height="1" width="680" src="images/1dot_919699.gif" alt=""><br>
<img width="680" height="20" src="images/1dot.gif" alt=""></td>
</tr>
<tr>
<td scope="row">
<!--googleon: index -->
<pre class="sourcecodebox"><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"
"http://www.w3.org/MarkUp/Wilbur/HTML32.dtd">
<html lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Support for Tracking</title>
<meta name="generator" content="BBEdit 8.2">
<style type="text/css">
<!--
.mybox {
background-color: #F7F7F7;
margin: 4px;
padding: 4px;
border: 1px solid #999999;
}
-->
<!--
.mycodebox {
background-color: #F1F5F9;
margin: 4px;
padding: 4px;
border: 1px solid #999999;
}
-->
</style>
</head>
<body>
<h1>
Tutorial: Writing a custom HIView
</h1>
<h2>
C) Implementing support for tracking
</h2>
<p>
Tracking means receiving a mouse-down event and showing some sort of feedback as the user moves the mouse around the control, ending with a mouse-up event.
</p>
<p>
The HIView Manager automatically supports basic tracking, which is the model used for simple clickable views such as a push button or checkbox. In this model, the view shows a hilited appearance while the mouse is pressed inside the view, unhilites when the mouse moves outside of the view, and generates kEventControlHit and kEventCommandProcess events if the mouse is released inside the view. In order to use the basic tracking support, you only have to implement kEventControlHitTest.
</p>
<p>
The HIView Manager also allows a view to provide custom tracking. A view would provide custom tracking behavior if it needs to provide a more complex response to a mouse click; for example, custom tracking would be required in order to display a menu in response to a click, or to start a drag operation. To implement custom tracking, you must implement kEventControlTrack. You should not implement kEventControlTrack if you only need to use the basic tracking support.
</p>
<p>
Let’s go over the basic tracking first: you add the kEventControlHitTest event to the event list that you register in GetHICustomViewClass:
</p>
<div class="mycodebox"><pre>
static EventTypeSpec kFactoryEvents[] =
{
{ kEventClassHIObject, kEventHIObjectConstruct },
{ kEventClassHIObject, kEventHIObjectDestruct },
{ kEventClassControl, kEventControlDraw },
{ kEventClassControl, kEventControlValueFieldChanged },
{ kEventClassControl, kEventControlHiliteChanged },
{ kEventClassControl, kEventControlHitTest }
};
</pre></div>
<p>
And you add one more case in the function Internal_HICustomViewHandler:
</p>
<div class="mycodebox"><pre>
case kEventControlHitTest:
{
HIPoint mouseLoc;
status = GetEventParameter(inEvent, kEventParamMouseLocation, typeHIPoint, NULL, sizeof(mouseLoc), NULL, &mouseLoc);
require_noerr(status, ControlHitTestExit);
HIRect hiBounds;
status = HIViewGetBounds(myData->view, &hiBounds);
require_noerr(status, ControlHitTestExit);
ControlPartCode partCode = ( CGRectContainsPoint(hiBounds, mouseLoc) ) ? kControlButtonPart : kControlNoPart;
status = SetEventParameter(inEvent, kEventParamControlPart, typeControlPartCode, sizeof(partCode), &partCode);
require_noerr(status, ControlHitTestExit);
ControlHitTestExit:
break;
}
</pre></div>
<p>
In this example, we do not have multiple parts so we just verify that the proposed location is within the bounds of our custom HIView. In order for the HIToolbox to set the hilite state correctly, you need to return in the kEventParamControlPart parameter a non-zero value less than 128. In this example, for convenience, we just return kControlButtonPart.
</p>
<div class="mybox">
<strong>
Note: The mouse location received in the kEventParamMouseLocation parameter is in the view-local coordinate system, not in the global or owning window coordinate system, so we can just test if the view bounds which are also in the same view-local coordinate system contains that location.
</strong>
</div>
<p>
You can test the custom HIView for this step by using the project located in the folder “3_Basic_Tracking”.
</p>
<p>
To support custom Tracking, we simply add one more event in the event list that you register in GetHICustomViewClass and add two fields to our private data:
</p>
<div class="mycodebox"><pre>
typedef struct
{
HIViewRef view; // our view
Boolean trackOn; // tracking information
HIPoint trackSpot;
}
HICustomViewData;
static EventTypeSpec kFactoryEvents[] =
{
{ kEventClassHIObject, kEventHIObjectConstruct },
{ kEventClassHIObject, kEventHIObjectDestruct },
{ kEventClassControl, kEventControlDraw },
{ kEventClassControl, kEventControlValueFieldChanged },
{ kEventClassControl, kEventControlHiliteChanged },
{ kEventClassControl, kEventControlHitTest },
{ kEventClassControl, kEventControlTrack }
};
</pre></div>
<p>
And you add one more case in the function Internal_HICustomViewHandler:
</p>
<div class="mycodebox"><pre>
case kEventControlTrack:
{
// handling the mouse tracking
status = Internal_HICustomViewTrack(myData, inEvent);
break;
}
</pre></div>
<p>
and the function Internal_HICustomViewTrack is implemented this way:
</p>
<div class="mycodebox"><pre>
static OSStatus Internal_HICustomViewTrack(HICustomViewData * myData, EventRef inEvent)
{
// Here we are having some fun with a time-controlled value setting
// The value is going to be incremented each time we move within our bounds
// or incremented every 1/3 second if we don't move but are within our bounds
// If we reach the maximum, we go back to the minimum
OSStatus status;
// Getting our bounds and locations
HIRect hiViewBounds;
status = HIViewGetBounds(myData->view, &hiViewBounds);
require_noerr(status, HIViewGetBounds);
Rect qdWindowBounds;
status = GetWindowBounds(GetControlOwner(myData->view), kWindowStructureRgn, &qdWindowBounds);
require_noerr(status, GetWindowBounds);
HIPoint hiPoint;
status = GetEventParameter(inEvent, kEventParamMouseLocation, typeHIPoint, NULL, sizeof(hiPoint), NULL, &hiPoint);
require_noerr(status, GetEventParameter);
// handle the first mouseDown before moving
MouseTrackingResult mouseStatus = kMouseTrackingMouseDown;
while (mouseStatus != kMouseTrackingMouseUp)
{
if (CGRectContainsPoint(hiViewBounds, hiPoint))
{
if (hiPoint.x < hiViewBounds.origin.x+4) hiPoint.x = hiViewBounds.origin.x+4;
if (hiPoint.x > hiViewBounds.origin.x+hiViewBounds.size.width-4) hiPoint.x = hiViewBounds.origin.x+hiViewBounds.size.width-4;
if (hiPoint.y < hiViewBounds.origin.y+4) hiPoint.y = hiViewBounds.origin.y+4;
if (hiPoint.y > hiViewBounds.origin.y+hiViewBounds.size.height-4) hiPoint.y = hiViewBounds.origin.y+hiViewBounds.size.height-4;
myData->trackSpot = hiPoint;
// setting the new value
SInt32 currentValue = GetControl32BitValue(myData->view);
UInt32 newValue = currentValue + 1;
newValue %= (GetControl32BitMaximum(myData->view) + 1);
SetControl32BitValue(myData->view, newValue);
myData->trackOn = true;
HiliteControl(myData->view, 1);
}
else if (myData->trackOn)
{
myData->trackOn = false;
HiliteControl(myData->view, 0);
}
// a -1 GrafPtr to TrackMouseLocationWithOptions yields global coordinates
Point qdPoint;
status = TrackMouseLocationWithOptions((GrafPtr)-1L, 0, kEventDurationSecond / 3, &qdPoint, NULL, &mouseStatus);
require_noerr(status, TrackMouseLocation);
// convert to window-relative coordinates
hiPoint.x = qdPoint.h - qdWindowBounds.left;
hiPoint.y = qdPoint.v - qdWindowBounds.top;
// convert to view-relative coordinates
HIViewConvertPoint(&hiPoint, NULL, myData->view);
}
SendEventToEventTarget:
GetWindowEventTarget:
SetEventParameter:
CreateEvent:
TrackMouseLocation:
GetEventParameter:
GetWindowBounds:
HIViewGetBounds:
myData->trackOn = false;
HiliteControl(myData->view, 0);
return status;
}
</pre></div>
<p>
The last thing we have to do is to add the tracking spot drawing in our kEventControlDraw handler:
</p>
<div class="mycodebox"><pre>
// if we're tracking then we also draw the track spot
if (myData->trackOn)
{
CGContextBeginPath(context);
CGContextAddArc(context, myData->trackSpot.x, myData->trackSpot.y, 10, 0, 2 * pi, 1);
CGContextClosePath(context);
CGContextSetRGBFillColor(context, 0.7, 0, 0.7, 0.8);
CGContextSetRGBStrokeColor(context, 0, 0.7, 0.7, 0.8);
CGContextDrawPath(context, kCGPathFillStroke);
}
</pre></div>
<p>
And you will see the following tracking:
</p>
<img src="../0_Tutorial/Picture%204.png" alt="" width="534" height="468">
<p>
If you do custom Tracking, you must use the APIs TrackMouseLocation or TrackMouseLocationWithOptions to follow the mouse movements. Do not use tight loops and the APIs Button, WaitMouseUp or StillDown since they use 100% of CPU time while doing nothing. Furthermore, as you can see in the Internal_HICustomViewTrack function, there is no direct drawing during the custom tracking but just a request for redraw which will be honored as soon as you enter TrackMouseLocationWithOptions. Thus, respecting the Golden Rule of the HIView Architecture, all the drawing is located in the kEventControlDraw handler.
</p>
<p>
You can test the custom HIView for this step by using the project located in the folder “4_Custom_Tracking”.
</p>
<br>
<a href="../0_Tutorial/Custom%20Cursor.html">Next Page
</a>
<br>
<br>
<a href="../0_Tutorial/Value%20and%20State.html">Previous Page
</a>
<br>
<br>
<a href="../0_%20Tutorial%20Start%20Here.html">Return to Main Page
</a>
</body>
</html>
</pre>
<!--googleoff: index -->
</td>
</tr>
</table>
<!-- END WIDE COLUMN -->
<!-- END MAIN CONTENT -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td><div style="width: 100%; height: 1px; background-color: #919699; margin-top: 5px; margin-bottom: 15px"></div></td>
</tr>
<tr>
<td align="center"><br/>
<table border="0" cellpadding="0" cellspacing="0" class="graybox">
<tr>
<th>Did this document help you?</th>
</tr>
<tr>
<td>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=1&url=/samplecode/Custom_HIView_Tutorial/listing7.html%3Fid%3DDTS10003657-1.0&media=dvd" target=_new>Yes</a>: Tell us what works for you.</div>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=2&url=/samplecode/Custom_HIView_Tutorial/listing7.html%3Fid%3DDTS10003657-1.0&media=dvd" target=_new>It’s good, but:</a> Report typos, inaccuracies, and so forth.</div>
<div><a href="http://developer.apple.com/feedback/?v=3&url=/samplecode/Custom_HIView_Tutorial/listing7.html%3Fid%3DDTS10003657-1.0&media=dvd" target=_new>It wasn’t helpful</a>: Tell us what would have helped.</div>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- START BOTTOM APPLE NAVIGATION -->
<!--#include virtual="/includes/footer"-->
<!-- END BOTTOM APPLE NAVIGATION -->
<!-- START CENTER CLOSE -->
</center>
<!-- END CENTER CLOSE -->
</body>
</html>