TweetFollow Us on Twitter

Using Controls
Volume Number:1
Issue Number:4
Column Tag:Forth Forum

Using Controls

By Jörg Langowski

In this month’s column I want to introduce to you some concepts of control handling on the Macintosh under MacForth. Controls, as you might have guessed by now, are a very basic concept of the Macintosh user interface: a major part of mouse input to an application is done through controls.

The four main types of controls that show up to you when you work with an application are buttons, check boxes, radio buttons and dials, and these are the ones that we will be talking about this time.

All control handling routines are built into the toolbox ROM. Therefore, one can call them - in principle - from any programming environment as toolbox traps. MacForth, of course, makes this job a little easier by providing a large number of predefined routines. Interestingly enough, most of these routines are already present in Version 1.1, even though the manual says that 1.1 does not support controls. I suppose this was a typo. They wanted to say that it does not document controls. Well, the Inside Macintosh manual does that very extensively and as you will see, it is not hard to transfer those concepts into Forth.

Let’s first look at the definitions of the four control types, as they are given in IM:

Buttons are the little rounded rectangles that have a text inside. When you click a button with the mouse, you tell the application to perform some action as shown in the example below.

“Yes” and “No” are buttons and you may choose either one.

Check boxes show the state of a parameter that can be on or off, and can be clicked on/off with the mouse:

Radio buttons are sets of buttons, only one of which may be on. They are used to set and display parameters that can assume discrete values or states, such as integer numbers:

Dials, the scroll bar being the most familiar example, are used to set and display a parameter that can change continuously (or quasi-continuously, such as the position in a text file).

Generating a control in your active window is very simple, it requires only one toolbox call. Just putting a control into a window like that, however, is useless. You can click and point at it as long as you wish, it won’t do anything unless you tell it what to do. Clicking a control only generates an event that your program has to recognize. For instance, if a radio button is clicked you have to make sure that the corresponding parameter is set on and all others that belong to the same group of radio buttons are turned off. If the page region in a scroll bar is clicked you have to tell the system what to do, change the parameter value and show the scroll bar with its new value.

But then, there is not much more to do. The Control Manager will auto- matically determine if you clicked a control and which one, and will also ‘track’ the control, that is, display it changing while you perform some action on it with the mouse. It will also, if appropriate, inactivate a control, which is then displayed in a different way and any actions on it are ignored (like the scroll bars in the Finder windows if all the icons fit into the window).

Let’s assume we want to generate a window that contains the following controls:

• a scroll bar that can be changed through a range from 0 to 300

• a check box that is used to turn the scroll bar on and off.

An example program that does these functions is given below, and most of it should be self-explanatory. The Toolbox function NewControl that creates a new control in a window, however, has to be explained in a little more detail.

It expects 10 parameters on the stack, from bottom to top:

- 4 bytes for the function result ControlHandle

- WindowPtr, the pointer to the window that the new control belongs to

- boundsRect, the address of a rectangle that gives the control’s size and location in the window’s local coordinates

- title, a pointer to the control’s title

- visible, a boolean value (16 bit); if TRUE, the control is actually drawn inside the window, otherwise, it’s invisible

- value, a 16-bit integer, the control’s initial value

- min, 16-bit integer, the control’s minimum value

- max, 16-bit integer, the control’s maximum value

- procID, 16-bit integer, a number that defines the type of control:

- 0 - simple button, 1 - check box, 2 - radio button, 16 - scroll bar.

- refCon, 32-bit integer, a number that you may use as a unique reference number; it is not used by the Control Manager at all.

This set of parameters is rather impressive, and you can immediately see that none of the standard toolbox trap defining words in MacForth can be used to call this function. First, only function calls with at most one parameter are supported, for the others you have to include space for the result on the stack and use the MT defining word. Second, there are five 16-bit parameters between 32-bit ones, and Forth normally pushes 32-bit items on the stack.

MacForth 2.0 has the word ADD.CONTROL built in, which is called with the stack set up like above, only the integers are all 32-bit. ADD.CONTROL then converts visible, value, min, max, and procID to 16 bits and calls NewControl, which creates the control. However, if you have MacForth 1.1, you can define your own ADD.CONTROL by using the 16-bit push PUSHW that was defined in the last MacTech. The example below contains the definitions of PUSHW and ADD.CONTROL.

The scroll bar that we define is horizontal. The up button and page-up regions of a horizontal bar are on the left side, but the bar is incremented to the right (an inconsistency in the Control Manager). Therefore the program decrements the control’s value when the up button is clicked and increments it on the down button.

The only other control in the example is a check box that turns the scroll bar on and off. I have not included simple buttons or radio buttons; you may want to try them out on your own by setting procID to different values. Remember, if you define a set of radio buttons, your program has to keep track of which one is on and turn the others off. There is no way how the Control Manager could know which buttons belong to the same group.

( Demo program for using the Control Manager from Mac Forth )
( © 1985  MacTutor by J. Langowski  )

( pushw, new.control ) hex
: pushw s0 @ >R sp@ 2- s0 ! sp! r> s0 ! drop ;
A954 mt (new.control)
: add.control
  >r ( refCon )   >r ( procID )  >r ( max )   >r ( min )   >r ( value 
)
  pushw  ( visible ) r> pushw  ( value )
  r> pushw  ( min )  r> pushw ( max ) r> pushw  ( procID )  r> ( refCon 
)
 (new.control)  ;

( test window for new.control )              ( JL Jan 1985 )
decimal  new.window my.window  50 100 200 450 my.window w.bounds
close.box size.box + my.window w.attributes   my.window add.window
50 50 75 300 rect my.scroll
( set up scroll bar )
0 my.window my.scroll 
“  “ ( no title )
 -1  ( visible=true )
100  ( value )
0    ( min )
300  ( max )
16   ( procID for scroll bar )
here ( to get a unique ref # )
add.control 
constant my.control in.heap ( so that handle is released when FORGETting 
)

( on/off box for test window )
25 50 40 200 rect button.a.rect ( check box )
0 my.window button.a.rect “  Scroll Bar Off” -1 0 0 1 1 ( check box ) 

here add.control
constant my.button in.heap   my.window show.controls
80 50 95 150 rect text.rect  ( for output )

( control tracking )
( track control, given a control handle and mouse position, tracks a 
control )
: my.track this.control @ @mouse track.control ;

( get.control, given a control handle, gets the value of that control 
)
: show.value my.control get.control text.rect erase.rect
             0 textfont  50 90 move.to .” Value:” . .”    “  ;

( set.control, given a control handle and an integer, sets the control 
to 
  that integer value )

( scroll bar )
: do.thumb  my.track drop get.window show.controls show.value ;
: inc.scroll this.control @ dup get.control 1+ set.control show.value 
;
: dec.scroll this.control @ dup get.control 1- set.control show.value 
;
: inc10.scroll this.control @ dup get.control 10 + set.control show.value 
;
: dec10.scroll this.control @ dup get.control 10 - set.control show.value 
;

( scroll bar )
: do.scroll.bar  case in.thumb of  do.thumb   endof
           up.button of dec.scroll endof  down.button of inc.scroll endof
           page.up of dec10.scroll endof  page.down of inc10.scroll endof
                 endcase  ;


( check box )
( hilite.control, given control handle and integer value, sets the control
 active if value=0 and inactive if value=255 ) 
: do.button drop my.track if this.control @ dup get.control 1 swap -
                         my.control over 255 * hilite.control set.control 
then
     get.window show.controls ;

( control actions )
: do.controls swap  case my.control of  do.scroll.bar endof
                         my.button  of  do.button endof
                    endcase ;

( event loop for test window )
: my.action show.value if begin do.events
                          case mouse.down of  @mouse.dn get.window
                             find.control ?dup if do.controls then endof
                          endcase again
  else .” My Window Deactivated” then ;

my.window on.activate my.action

 
AAPL
$97.52
Apple Inc.
+2.80
MSFT
$44.93
Microsoft Corpora
+0.10
GOOG
$596.47
Google Inc.
+1.73

MacTech Search:
Community Search:

Software Updates via MacUpdate

Firefox 31.0 - Fast, safe Web browser. (...
Firefox for Mac offers a fast, safe Web browsing experience. Browse quickly, securely, and effortlessly. With its industry-leading features, Firefox is the choice of Web development professionals... Read more
Little Snitch 3.3.3 - Alerts you to outg...
Little Snitch gives you control over your private outgoing data. Track background activityAs soon as your computer connects to the Internet, applications often have permission to send any... Read more
Thunderbird 31.0 - Email client from Moz...
As of July 2012, Thunderbird has transitioned to a new governance model, with new features being developed by the broader free software and open source community, and security fixes and improvements... Read more
Together 3.2 - Store and organize all of...
Together helps you organize your Mac, giving you the ability to store, edit and preview your files in a single clean, uncluttered interface. Smart storage. With simple drag-and-drop functionality,... Read more
Cyberduck 4.5 - FTP and SFTP browser. (F...
Cyberduck is a robust FTP/FTP-TLS/SFTP browser for the Mac whose lack of visual clutter and cleverly intuitive features make it easy to use. Support for external editors and system technologies such... Read more
iExplorer 3.4 - View and transfer all th...
iExplorer is an iPhone browser for Mac lets you view the files on your iOS device. By using a drag and drop interface, you can quickly copy files and folders between your Mac and your iPhone or... Read more
Airmail 1.4 - Powerful, minimal email cl...
Airmail is a powerful, minimal mail client.It was designed to retain the same experience with a single or multiple accounts and provide a quick, modern and easy-to-use user experience. Airmail... Read more
Macs Fan Control 1.1.12 - Monitor and co...
Macs Fan Control allows you to monitor and control almost any aspect of your computer's fans, with support for controlling fan speed, temperature sensors pane, menu-bar icon, and autostart with... Read more
A Better Finder Rename 9.37 - File, phot...
A Better Finder Rename is the most complete renaming solution available on the market today. That's why, since 1996, tens of thousands of hobbyists, professionals and businesses depend on A Better... Read more
MacBook Air EFI Firmware Update 2.9 - Fo...
MacBook Air EFI Firmware Update is recommended for MacBook Air (Mid 2011) models. This update addresses an issue where systems may take longer to wake from sleep than expected and fixes a rare issue... Read more

Latest Forum Discussions

See All

Ex-Angry Birds Developers Release Monsu...
Ex-Angry Birds Developers Release Monsu Teaser Trailer Posted by Jennifer Allen on July 23rd, 2014 [ permalink ] Finnish developer Boomlagoon has released a teaser trailer of their forthcoming side-scrolling action platformer, | Read more »
Lots of New Modes Have Been Added to Can...
Lots of New Modes Have Been Added to Canabalt Posted by Jennifer Allen on July 23rd, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Stronghold 3: The Campaigns Review
Stronghold 3: The Campaigns Review By Jennifer Allen on July 23rd, 2014 Our Rating: :: DULL STRATEGIZINGiPad Only App - Designed for the iPad A cumbersome strategy game, Stronghold 3: The Campaigns has a few too many issues to... | Read more »
Table Tennis Touch on Sale for a Limited...
Table Tennis Touch on Sale for a Limited Time Posted by Jessica Fisher on July 23rd, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Secret Files Tunguska Review
Secret Files Tunguska Review By Jennifer Allen on July 23rd, 2014 Our Rating: :: CONSPIRACY-LITTERED ADVENTURINGUniversal App - Designed for iPhone and iPad Offering traditional adventuring with no fear of in-app purchases, Secret... | Read more »
Celebrate Summer With a Cat in the Hat L...
Celebrate Summer With a Cat in the Hat Learning Library Sale Posted by Ellis Spice on July 22nd, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Dragon Raiders Review
Dragon Raiders Review By Nadia Oxford on July 22nd, 2014 Our Rating: :: RUN, DRAGON, RUNUniversal App - Designed for iPhone and iPad Dragon Raiders is rough and scaly in some parts, but overall it’s an enjoyable level-based running... | Read more »
MyTaskList Review
MyTaskList Review By Jennifer Allen on July 22nd, 2014 Our Rating: :: EFFECTIVE IF PLAINUniversal App - Designed for iPhone and iPad It’s not the most stylish of task management apps, but MyTaskList has all the features you could... | Read more »
FlyCraft Herbie: Crazy Machines Review
FlyCraft Herbie: Crazy Machines Review By Jennifer Allen on July 22nd, 2014 Our Rating: :: TRICKY FLYINGUniversal App - Designed for iPhone and iPad A tough game of careful thrusting and navigation, FlyCraft Herbie: Crazy Machines... | Read more »
MTN Review
MTN Review By Jessica Fisher on July 22nd, 2014 Our Rating: :: ADORABLE, SERENE, AND AMUSINGUniversal App - Designed for iPhone and iPad MTN is an adorable, talking pet mountain that is less game and more zen garden.   | Read more »

Price Scanner via MacPrices.net

With The Apple/IBM Alliance, Is The iPad Now...
Almost since the iPad was rolled out in 2010, and especially after Apple made a 128 GB storage configuration available in 2012, there’s been debate over whether the iPad is a serious tool for... Read more
MacBook Airs on sale starting at $799, free s...
B&H Photo has the new 2014 MacBook Airs on sale for up to $100 off MSRP for a limited time. Shipping is free, and B&H charges NY sales tax only. They also include free copies of Parallels... Read more
Apple 27″ Thunderbolt Display (refurbished) a...
The Apple Store has Apple Certified Refurbished 27″ Thunderbolt Displays available for $799 including free shipping. That’s $200 off the cost of new models. Read more
WaterField Designs Unveils Cycling Ride Pouch...
High end computer case and bag maker WaterField Designs of San Francisco now enters the cycling market with the introduction of the Cycling Ride Pouch – an upscale toolkit with a scratch-free iPhone... Read more
Kingston Digital Ships Large Capacity Near 1T...
Kingston Digital, Inc., the Flash memory affiliate of Kingston Technology Company, Inc.,has announced its latest addition to the SSDNow V300 series, the V310. The Kingston SSDNow V310 solid-state... Read more
Apple’s Fiscal Third Quarter Results; Record...
Apple has announced financial results for its fiscal 2014 third quarter ended June 28, 2014, racking up quarterly revenue of $37.4 billion and quarterly net profit of $7.7 billion, or $1.28 per... Read more
15-inch 2.0GHz MacBook Pro Retina on sale for...
B&H Photo has the 15″ 2.0GHz Retina MacBook Pro on sale for $1829 including free shipping plus NY sales tax only. Their price is $170 off MSRP. B&H will also include free copies of Parallels... Read more
Apple restocks refurbished Mac minis for up t...
The Apple Store has restocked Apple Certified Refurbished Mac minis for up to $150 off the cost of new models. Apple’s one-year warranty is included with each mini, and shipping is free: - 2.5GHz Mac... Read more
Twelve South HiRise For MacBook – Height-Adju...
If you use your MacBook as a workhorse desktop substitute, as many of us do, a laptop stand combined with an external keyboard and pointing device are pretty much obligatory if you want to avoid... Read more
Why The Mac Was Not Included In The Apple/IBM...
TUAW’s Yoni Heisler cites Fredrick Paul of Network World whoi blogged last week that the Mac’s conspicuous absence from Apple and IBM’s landmark partnership agreement represents a huge squandered... Read more

Jobs Board

Sr Software Lead Engineer, *Apple* Online S...
Sr Software Lead Engineer, Apple Online Store Publishing Systems Keywords: Company: Apple Job Code: E3PCAK8MgYYkw Location (City or ZIP): Santa Clara Status: Full 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
Sr *Apple* Engineer - IT - Requisition #: -...
For more information about TIAA-CREF, visit our website . The Apple Engineer will provide engineering and third-level incident support for 300- 500 MacOS desktop/laptop Read more
*Apple* Systems Administrator - DISH (United...
…satellite service provider, and Dish is currently looking for an experienced Apple /Mac Systems Administrator. Apple systems administrator will be responsible for Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.