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

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

MacUpdate Desktop 6.0.8 - Search and ins...
MacUpdate Desktop 6 brings seamless 1-click installs and version updates to your Mac. With a free MacUpdate account and MacUpdate Desktop 6, Mac users can now install almost any Mac app on macupdate.... Read more
BitTorrent Sync 2.1.1 - Sync files secur...
BitTorrent Sync allows you to sync unlimited files between your own devices, or share a folder with friends and family to automatically sync anything. File transfers are encrypted. Your information... Read more
Quicksilver 1.3.0 - Application launcher...
Quicksilver is a light, fast and free Mac application that gives you the power to control your Mac with keystrokes alone. Quicksilver allows you to find what you need quickly and easily, then act... Read more
iWatermark Pro 1.72 - Easily add waterma...
iWatermark Pro is the essential watermarking app for professional, business, and personal use. iWatermark, is the number 1 and only watermarking tool available for all 4 platforms iPhone/iPad, Mac,... Read more
RapidWeaver 6.3 - Create template-based...
RapidWeaver is a next-generation Web design application to help you easily create professional-looking Web sites in minutes. No knowledge of complex code is required, RapidWeaver will take care of... Read more
Adobe Photoshop CC 2015 16.0.1 - Profess...
Photoshop CC 2015 is available as part of Adobe Creative Cloud for as little as $19.99/month (or $9.99/month if you're a previous Photoshop customer). Photoshop CS6 is still available for purchase (... Read more
Together 3.4.6 - Store and organize all...
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
Monosnap 3.1.0 - Versatile screenshot ut...
Monosnap lets you capture screenshots, share files, and record video and .gifs! Capture: Capture full screen, just part of the screen, or a selected window Make your crop area pixel perfect with... Read more
Cocktail 8.5.1 - General maintenance and...
Cocktail is a general purpose utility for OS X that lets you clean, repair and optimize your Mac. It is a powerful digital toolset that helps hundreds of thousands of Mac users around the world get... Read more
Vienna 3.0.6 :5eaf312: - RSS and Atom ne...
Vienna is a freeware and Open-Source RSS/Atom newsreader with article storage and management via a SQLite database, written in Objective-C and Cocoa, for the OS X operating system. It provides... Read more

Five Nights at Freddy's 4 has Been...
In keeping with tradition, Five Nights at Freddy's 4 has made its way to the App Store with zero warning fanfare. Honestly I'd be disappointed it if happened any other way at this point. [Read more] | Read more »
Doom & Destiny Advanced (Games)
Doom & Destiny Advanced 2.3.4.0 Device: iOS Universal Category: Games Price: $.99, Version: 2.3.4.0 (iTunes) Description: ---SUPER GIGA LAUNCH DISCOUNT! Get it now for cheap or pay more later!---An additional 143 MB download is... | Read more »
Five Nights at Freddys 4 (Games)
Five Nights at Freddys 4 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: This time, the terror has followed you home. | Read more »
This Week at 148Apps: July 27-31, 2015
Winding Down July With 148Apps How do you know what apps are worth your time and money? Just look to the review team at 148Apps. We sort through the chaos and find the apps you're looking for. The ones we love become Editor’s Choice, standing out... | Read more »
You'll Want to Keep an Eye Out for...
If you're the kind of person who had fun hunting down and completing all the codex puzzles in Assassin's Creed 2, then are you ever in for a treat. The Guides looks like it's going to be a very robust collection of similarily odd, seemingly... | Read more »
Vivid Games has Announced Real Boxing 2...
The original Real Boxing was a pretty impressive bit of fisticuffs, but if the trailer Vivid Games is showing off for GamesCom is any indication Real Boxing 2 is going to be even better. [Read more] | Read more »
PAC-MAN Championship Edition DX - Tips,...
[Read more] | Read more »
Card King: Dragon Wars - Tips, Tricks an...
[Read more] | Read more »
Pac-Man Championship Edition DX has brou...
Bandai Namco has released Pac-Man Championship Edition DX on iOS and Android, which features the classic arcade gameplay that we've all grown to love. Pac-Man Championship Edition DX can be enjoyed in much shorter bursts than the arcade versions... | Read more »
Cosmonautica (Games)
Cosmonautica 1.1 Device: iOS Universal Category: Games Price: $6.99, Version: 1.1 (iTunes) Description: Cast off! Are you ready for some hilarious adventures in outer space? | Read more »

Price Scanner via MacPrices.net

MacBook 12 Retina Pundit’s New Favorite Mac
If you’re eyeing the purchase of a new 12-inch Retina MacBook, but wondering if you can live with a single USB-C port, 2011-level CPU performance, and the unorthodox keyboard, you should find... Read more
PDF Element Tool Kit For PDF For Windows 10,...
South Surrey, British Columbia based software developer Wondershare has posted an interesting infographic tracking the development of Microsoft’s flagship Windows operating system over the years,... Read more
27-inch 3.5GHz 5K iMac on sale for $81 off MS...
Adorama has the 27″ 3.5GHz 5K iMac on sale for $2218, $81 off MSRP, including a free copy of Apple’s 3-Year AppleCare Protection Plan. Shipping is free, and Adorama charges sales tax in NY & NJ... Read more
Back-to-School with Tablet and Smartphone Acc...
Belkin helps you prepare for the coming school year with a wide variety of the latest mobile and tablet accessories to outfit both grade school and college students. The line-up includes charging... Read more
11-inch MacBook Airs on sale for $100 off MSR...
Best Buy has 11-inch MacBook Airs on sale for $100 off MSRP. Choose free shipping or free local store pickup (if available). Sale prices for online orders only, in-store prices may vary: - 11″ 1.6GHz... Read more
iPad Air 2 on sale for up to $100 off MSRP
Best Buy has iPad Air 2s on sale for up to $100 off MSRP on their online store for a limited time. Choose free shipping or free local store pickup (if available). Sale prices available for online... Read more
Sale! 13-inch MacBook Pros on sale for $100 o...
B&H Photo has 13″ MacBook Pros on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 2.5GHz/500GB MacBook Pro: $999.99 save $100 - 13″ 2.7GHz/128GB Retina... Read more
Sale! Save $100 on 13-inch MacBook Airs this...
B&H Photo has the 13″ 1.6GHz/128GB MacBook Air on sale for $899.99 including free shipping plus NY tax only. Their price is $100 off MSRP, and it’s the lowest price available for this model.... Read more
Worldwide Tablet Market Decline Continues, Ap...
The worldwide tablet market declined -7.0% year-over-year in the second quarter of 2015 (2Q15) with shipments totaling 44.7 million units according to preliminary data from the International Data... Read more
TP-LINK TL-PA8030P KIT Powerline Featuring Ho...
Consumer and business networking products provider TP-LINK is now shipping its TL-PA8030P KIT AV1200 3-Port Gigabit Passthrough Powerline Starter Kit that expands your home’s network over its... 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
Infrastructure Engineer - *Apple* /Mac - Hil...
Infrastructure Engineer - Apple /Mac Job Code: 1608 # of openings: 1 Description Our fortune 500 client is looking to hire an experienced Infrastructure Engineer to join Read more
Executive Administrative Assistant, *Apple*...
…supporting presentation development for senior leadership. * User experience with Apple hardware and software is preferred. Additional Requirements The following list Read more
*Apple* Bus Company is now hirin - Apple Bus...
Apple Bus Company is now hiring school bus drivers in the Pettis County area. Class B CDL preferred. Free training provided. No nights or weekends required. Flexible Read more
*Apple* Certified Mac Technician - Updated 6...
…and friendly, hands-on technical support to customers troubleshooting and repairing Apple /Mac products with courtesy, speed and skill. Use your problem-solving skills Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.