TweetFollow Us on Twitter

Splitting Windows
Volume Number:11
Issue Number:1
Column Tag:Improving The Framework

Splitting Windows in MacApp

You know, programming in MacApp is a lot like playing golf.

By Tom Otvos, EveryWare Development Corp.

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

You know, programming in MacApp is a lot like playing golf. With a little bit of practice, you can become fairly competent and hit a respectable score, and with about the same amount of practice, you can write a respectable, Mac-looking application. There will come a time, however, when you want to stretch the bounds a little bit, and add some cool user interface gadget that will differentiate your application from another. You want to hit a birdie on that par four 15th. To make that kind of advance, you need a little bit more than practice; you need a deeper understanding of the game, and the ability ”to read the greens”. You need to understand how some of these disparate parts of a rather complicated application framework come together, so you can not only make it do what you want, but do it the right way.

Before I lead you too far along, I should say at this point that I am not a very good golfer. I have not yet made that transition to really knowing what I am doing, and then merely applying that knowledge to the situation at hand. Okay, let’s cut to the chase. I am struggling. I have been doing MacApp a bit longer, however, and so I can generally get it to do what I want in the way that I want it with relative ease. Along the way, I have picked up a few tricks that, in the end, are really very simple, but they achieve a neat effect that has a lot of application. In this article, I want to talk about a useful trick that, amazingly, I was not able to find documented anywhere else, namely splitting windows. I really needed to split windows for an app that I am working on, so I created the following two classes to do it. Since it was really very simple and a trivial amount of code, I figured that sharing it would be the right thing to do. I hope you find it useful.

Splitting components

So that we have a clear picture in our heads during the following discussion, let’s look at the geometry a bit. Splitting windows, in MacApp terms, really reduces to taking two TView objects and adjusting their sizes inversely relative to each other. In the simplest case, picture two views joined along one edge, and then dragging that edge so that as one view grows in size, the other shrinks. If the two view objects are the same class, then you can easily implement the classic word processing implementation of splitting, where you are looking at the same document in two or more panes, each displaying a different region of the document. Or, the two views can be from very different classes that display some common data in different ways. An example might be a view editor that shows the view hierarchy as it would appear on screen in one area, and a list representation of the hierarchy in another area.

To split a window, I have created two classes: TSplitterControl and TSplitterTracker. The TSplitterControl class does two very simple things. First, it provides a user interface to the splitting action, giving the user a “knob” to direct the split. Second, it is responsible, at the programmatic level, for initiating the splitting by instantiating the splitter tracker. The TSplitterTracker class is the workhorse of the pair, as it tracks the mouse during splitting, providing continual user feedback and, ultimately, reconfiguring the views after the splitting is done. [Because the code for these classes is so simple, I will include it in the text of this article. Some code polish that I have added to my classes will be omitted, but I assure you that nothing important will be left out.]

TSplitterControl

The class definition for the TSplitterControl is reproduced below.

class TSplitterControl : public TControl
{
private:
 TView* fFirstView;
 TView* fSecondView;
public:
 virtual pascal void Initialize();
 virtual pascal void DoMouseCommand(
 VPoint&    theMouse, 
 TToolboxEvent*  event, 
 CPoint   hysteresis);
 virtual pascal void Draw(const VRect& area); 
 // override
 virtual pascal void SuperViewChangedFrame(
 const VRect&  oldFrame,  
 const VRect&  newFrame,  
 Boolean  invalidate);
 virtual pascal void SetSplitViews(
 TView* firstView, 
 TView* secondView);
};

The only method that is of any real consequence is DoMouseCommand():

pascal void TSplitterControl::DoMouseCommand(
 VPoint&    theMouse, 
 TToolboxEvent*  event, 
 CPoint   hysteresis)
 // override
{
    // mouse hits in our control will immediately post a splitter
    // tracker command
 TSplitterTracker* splitter = new TSplitterTracker;
 splitter->ISplitterTracker(fFirstView, 
 fSecondView, this, theMouse);
 this->PostCommand(splitter);
 
 inherited::DoMouseCommand(theMouse, event, hysteresis);
}

The only function of this method is to detect mouse hits in our control and post an instance of our splitter tracker. Note that in MacApp a TTracker is a TCommand subclass and needs to be posted in the command queue to get executed. Also note that the control passes to the tracker two views as part of its initialization. These two views are the views that are going to be adjusted at the end of the splitting process.

The remaining methods of this class are what I lump into “polish”, and you can provide your own variations as you see fit. Specifically, the Draw() method can be overridden, as I originally did, to draw a filled rectangle as the splitting knob. Users of Microsoft Word or MPW will find this type of splitter familiar. Ultimately, I opted for a splitting more like Object Master or MacBrowse, in which window panes are dragged by their edges to reconfigure their sizes. In this case, the Draw() method is superfluous, and the default MacApp drawing with appropriate adornment suits me just fine. The override to SuperViewChangedFrame() is necessary if you position your control such that its location needs to be modified when the window is zoomed or otherwise resized. I can never understand why MacApp views do not have a position determiner instance variable, with values like posRelRightEdge, so that I do not always have to override this method.

In my implementation, I always had two views defined in my window and so effectively, my window was already split. The splitter was merely adjusting the relative sizes of these views. However, you could easily envision a case where you would want to do true splitting, and every time you dragged down on the splitter control, you would split off a new pane of the existing view. I haven’t tried this, but I would guess that the best way to do this would be to clone the view you wish to split in the DoMouseCommand() method, insert it into the superview at an appropriate location, set its initial size to zero, and then pass it into the TSplitterTracker as one of the views.

One other user interface tip: You can have MacApp automatically change the cursor when it tracks over your control without writing a single line of code. Just use your favorite view editor to tell MacApp that the control is going to handle the cursor (fHandlesCursor), and specify a cursor resource ID (fCursorID) that should be used. I use a neat double-headed arrow

TSplitterTracker

The tracker does most of the work required for splitting, and MacApp handles most of the work required for tracking. Typically, you only need to override methods of TTracker to provide specific user feedback, to constrain tracking in a particular direction, and to “do something” when the tracking is done. The class definition of TSplitterTracker is shown below:

class TSplitterTracker : public TTracker
{
private:
 VCoordinate fDelta;
 TView* fFirstView;
 TView* fSecondView;
 TView* fSplitter;
public:
 virtual pascal void ISplitterTracker(
 TView* firstView, 
 TView* secondView, 
 TView* splitter, 
 VPoint&  itsMouse);
 virtual pascal void TrackConstrain(
 TrackPhase aTrackPhase, 
 const VPoint&   anchorPoint, 
 const VPoint&   previousPoint,
 VPoint&  nextPoint, 
 Boolean  mouseDidMove); 
 // override
 virtual pascal void TrackFeedback(
 TrackPhase aTrackPhase, 
 const VPoint&   anchorPoint, 
 const VPoint&   previousPoint,
 const VPoint&   nextPoint, 
 Boolean  mouseDidMove, 
 Boolean  turnItOn); 
 // override
 virtual pascal void DoIt(); // override
};

I always found trackers a rather mystifying element of the MacApp architecture, until I sat down and actually wrote a couple. They turn out to be quite simple largely because MacApp handles a lot of the gory details for you. For example, if you want to limit tracking in a single direction, the only thing you have to do is override TrackConstrain() and do something like this:

 inherited::TrackConstrain(aTrackPhase, anchorPoint, 
 previousPoint, nextPoint, 
 mouseDidMove);
 if (mouseDidMove)
    // limit tracking to one direction only
 nextPoint.h = previousPoint.h;

Basically, this method gives you a chance to recalculate the position of the mouse, so that MacApp thinks that it only moved in one direction. In the example above, I am forcing the tracker to only track in the vertical direction.

Initializing the tracker includes one important detail that you must pay attention to. When you call ITracker, you must provide a view with which the tracker is associated. One of the side effects of this is that tracking will be clipped to this view, so typically you would specify an enclosing view that will contain all of the tracking, such as, in our case, the window being split.

The TrackFeedback() method, not surprisingly, allows you a chance to provide whatever feedback you wish to the user, as well as hook in during the various track “phases” to extract whatever information you might think is necessary. For example, in the code below, I use my override to initialize an instance variable that will be used to determine how much tracking was done, and when the tracking is done, I calculate how far the mouse tracked in the vertical direction:

 switch (aTrackPhase) {
 case trackBegin:// initialize our track delta
 fDelta = 0;
 break;
 case trackEnd:  // how far did we go?
    // anchor point is always in splitter coordinates
 anchor = anchorPoint;
 fSplitter->LocalToWindow(anchor);
 next = nextPoint;
    // next point is always in view coordinates
 fView->LocalToWindow(next);
 fDelta = next.v - anchor.v;
 break;
 }
    // draw some nice feedback for the user  
 PenSize(2, 2);
 PenPat(&qd.gray);
 fView->GetQDExtent(qdExtent);
 MoveTo(qdExtent[topLeft].h, nextPoint.v);
 LineTo(qdExtent[botRight].h, nextPoint.v);

Additionally, regardless of the track phase, I draw a thick gray line across the width of the views being split, giving the user clear and easily understood feedback. MacApp provides some default feedback for you, if you wish to use it, in the form of a gray outline of the view to which the tracker is attached, but generally, I find that I have to provide my own feedback for one reason or another.

As mentioned earlier, the TTracker class descends from TCommand, and it uses the DoIt() method of TCommand to signal when tracking is complete and you need to react to it in some way. Here is the DoIt() method in its entirety:

pascal void TSplitterTracker::DoIt()
{
 VRect frame1, frame2;
    // adjust fDelta so neither view becomes invalid
 fFirstView->GetFrame(frame1);
 if (fDelta < frame1.top - frame1.bottom)
 fDelta = frame1.top - frame1.bottom;
 fSecondView->GetFrame(frame2);
 if (fDelta > frame2.bottom - frame2.top)
 fDelta = frame2.bottom - frame2.top;
    // adjust the first view from the bottom, the second from the top
 frame1.bottom += fDelta;
 fFirstView->SetFrame(frame1, kRedraw);
 frame2.top += fDelta;
 fSecondView->SetFrame(frame2, kRedraw);
}

In the code above, after some preflighting to ensure that neither view becomes negative in size, the views’ frames are adjusted in the vertical dimension by the delta amount tracked by the tracker. Note that one view has its bottom adjusted, and the other has its top adjusted. We could just as easily have tracked in the horizontal direction, and consequently adjusted the right and left edges. Or, a truly generic tracker could have been written that could track in either direction, or both. A simple call to SetFrame() was all that was needed to resize the two views. If your view hierarchy is set up correctly, then all relevant subviews will resize as necessary. Additionally, any overrides to SuperViewChangedFrame() in your subviews will also be called, in case you need to do dynamic repositioning of objects not done automatically by MacApp.

The Final Word

As I stated at the outset, there is not a lot of code required to achieve the view splitting effect in MacApp. I was actually amazed that there was not already some sample code out there that I could mooch from. Equally amazing was that cries for help on MacApp3Tech$ from others looking for similar code went unanswered. Well, someone was listening, and I hope that this article helps.

Now, if someone can only help me cure my slice

 
AAPL
$104.83
Apple Inc.
+1.84
MSFT
$45.02
Microsoft Corpora
+0.64
GOOG
$543.98
Google Inc.
+11.27

MacTech Search:
Community Search:

Software Updates via MacUpdate

Delicious Library 3.3.2 - Import, browse...
Delicious Library allows you to import, browse, and share all your books, movies, music, and video games with Delicious Library. Run your very own library from your home or office using our... Read more
Art Text 2.4.8 - Create high quality hea...
Art Text is an OS X application for creating high quality textual graphics, headings, logos, icons, Web site elements, and buttons. Thanks to multi-layer support, creating complex graphics is no... Read more
Live Interior 3D Pro 2.9.6 - Powerful an...
Live Interior 3D Pro is a powerful yet very intuitive interior designing application. View Video Tutorials It has every feature of Live Interior 3D Standard, plus some exclusive ones: Create multi... Read more
The Hit List 1.1.7 - Advanced reminder a...
The Hit List manages the daily chaos of your modern life. It's easy to learn - it's as easy as making lists. And it's powerful enough to let you plan, then forget, then act when the time is right.... Read more
jAlbum Pro 12.2.4 - Organize your digita...
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.4 - Create custom photo gall...
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
ExpanDrive 4.1.7 - Access remote files o...
ExpanDrive builds cloud storage in every application, acts just like a USB drive plugged into your Mac. With ExpanDrive, you can securely access any remote file server directly from the Finder or... Read more
OmniOutliner Pro 4.1.3 - Pro version of...
OmniOutliner Pro is a flexible program for creating, collecting, and organizing information. Give your creativity a kick start by using an application that's actually designed to help you think. It'... Read more
Evernote 5.6.2 - Create searchable notes...
Evernote allows you to easily capture information in any environment using whatever device or platform you find most convenient, and makes this information accessible and searchable at anytime, from... Read more
OmniOutliner 4.1.3 - Organize your ideas...
OmniOutliner is a flexible program for creating, collecting, and organizing information. Give your creativity a kick start by using an application that's actually designed to help you think. It's... Read more

Latest Forum Discussions

See All

A Few Days Left (Games)
A Few Days Left 1.01 Device: iOS Universal Category: Games Price: $3.99, Version: 1.01 (iTunes) Description: Screenshots are in compliance to App Store's 4+ age rating! Please see App Preview for real game play! **Important: Make... | Read more »
Toca Boo (Education)
Toca Boo 1.0.2 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0.2 (iTunes) Description: BOO! Did I scare you!? My name is Bonnie and my family loves to spook! Do you want to scare them back? Follow me and I'll... | Read more »
Intuon (Games)
Intuon 1.1 Device: iOS Universal Category: Games Price: $.99, Version: 1.1 (iTunes) Description: Join the battle with your intuition in a new hardcore game Intuon! How well do you trust your intuition? Can you find a needle in a... | Read more »
Ravenous Rampage (Games)
Ravenous Rampage 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: | Read more »
Partia 2 (Games)
Partia 2 1.0.1 Device: iOS Universal Category: Games Price: $5.99, Version: 1.0.1 (iTunes) Description: Partia 2 is a SRPG (Strategy Role-playing) video game inspired by Fire Emblem and Tear Ring Saga series. In a high fantasy... | Read more »
Puzzle to the Center of the Earth Review
Puzzle to the Center of the Earth Review By Campbell Bird on October 23rd, 2014 Our Rating: :: SPELUNKING PUZZLESUniversal App - Designed for iPhone and iPad Do some puzzles to make some platforms in this smart and fun free-to-play... | Read more »
Sleep Attack TD Review
Sleep Attack TD Review By Jennifer Allen on October 23rd, 2014 Our Rating: :: A TRUE TWISTUniversal App - Designed for iPhone and iPad Sleep Attack TD is a tower defense game with a difference – you can rotate the layout – and it’s... | Read more »
Mecanic (Education)
Mecanic 1.0 Device: iOS Universal Category: Education Price: $1.99, Version: 1.0 (iTunes) Description: Plates, screws, wheels ... Everything you need to achieve whatever you want... MECHANICWith 'MECANIC' kids will have fun... | Read more »
Earn Your Master Camper Badge in Camp Po...
Earn Your Master Camper Badge in Camp Pokemon Posted by Jessica Fisher on October 23rd, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Garruk Gets His Revenge in a New Magic 2...
Garruk Gets His Revenge in a New Magic 2015 Expansion, Coming This November Posted by Jessica Fisher on October 23rd, 2014 [ permalink ] | Read more »

Price Scanner via MacPrices.net

Save up to $125 on Retina MacBook Pros
B&H Photo has the new 2014 13″ and 15″ Retina MacBook Pros on sale for up to $125 off MSRP. Shipping is free, and B&H charges NY sales tax only. They’ll also include free copies of Parallels... Read more
Apple refurbished Time Capsules available sta...
The Apple Store has certified refurbished Time Capsules available for up to $60 off MSRP. Apple’s one-year warranty is included with each Time Capsule, and shipping is free: - 2TB Time Capsule: $255... Read more
Textilus New Word, Notes and PDF Processor fo...
Textilus is new word-crunching, notes, and PDF processor designed exclusively for the iPad. I haven’t had time to thoroughly check it out yet, but it looks great and early reviews are positive.... Read more
WD My Passport Pro Bus-Powered Thunderbolt RA...
WD’s My Passport Pro RAID solution is powered by an integrated Thunderbolt cable for true portability and speeds as high as 233 MB/s. HighlightsOverviewSpecifications Transfer, Back Up And Edit In... Read more
Save with Best Buy’s College Student Deals
Take an additional $50 off all MacBooks and iMacs at Best Buy Online with their College Students Deals Savings, valid through November 1st. Anyone with a valid .EDU email address can take advantage... Read more
iPad Air 2 & iPad mini 3 Best Tablets Yet...
The new iPads turned out to be pretty much everything I’d been hoping for and more than I’d expected.”More” particularly in terms of a drinking-from-a-firehose choice of models and configurations,... Read more
Drafts 4 Reinvents iOS Productivity App
N Richland Hills, Texas based Agile Tortoise has announced the release of Drafts 4 for iPhone and iPad. Drafts is a quick capture note taking app with flexible output actions. Drafts 4 scales from... Read more
AT&T accepting preorders for new iPads fo...
AT&T Wireless is accepting preorders for the new iPad Air 2 and iPad mini 3, cellular models, for $100 off MSRP with a 2-year service agreement: - 16GB iPad Air 2 WiFi + Cellular: $529.99 - 64GB... Read more
Apple offering refurbished Mac Pros for up to...
The Apple Store is offering Apple Certified Refurbished 2013 Mac Pros 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... Read more
Select MacBook Airs $100 off MSRP, free shipp...
B&H Photo has 2014 a couple of MacBook Airs on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only. They also include free copies of Parallels Desktop and LoJack for... Read more

Jobs Board

*Apple* Solutions Consultant - Apple Inc. (U...
…important role that the ASC serves is that of providing an excellent Apple Customer Experience. Responsibilities include: * Promoting Apple products and solutions Read more
Senior Event Manager, *Apple* Retail Market...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global event strategy. Delivering an overarching brand story; in-store, Read more
*Apple* Solutions Consultant (ASC) - Apple (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
Project Manager / Business Analyst, WW *Appl...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work Read more
*Apple* Retail - Multiple Positions (US) - A...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.