TweetFollow Us on Twitter

Transmuting Text

Volume Number: 13 (1997)
Issue Number: 4
Column Tag: Programming Techniques

Transmuting Text

By Martin Frické, Tucson, Arizona

Seemlessly exchanging text labels and editable text objects

One common problem with diagrams and intricate dialogs is that there are often many separate editable text items that have a small storage overhead relative to their own data content. For example, the user may want to label the four corners of a square; each label editable and most labels, but perhaps not all, consist of only a few characters in one style. A problem arises in that the data-structures to support style and styled-editing are reasonably substantial.

For example, the Mac TERec is 96 bytes large compared with one byte to represent the single character that is actually on one of the corners of the drawn square. If a single body of text is large, the supporting style data-structures are insignificant, but with a multiplicity of small labels in a diagram, the content can easily get swamped by the support - as much as 200k can be used for one page of symbols. On the other hand, if the program considers a label to be just a string of characters, the label can be stored frugally and drawn easily, but it would not be as easily editable.

Many commercial programs do not fare terribly well with this problem (no names, no pack drill). There are a few standard techniques. Several painting programs use once-only editing. A new label is editable, but the moment that new label is de-activated, the text in it is converted into a bit-map and merged into the background. Therefore, this label cannot be recovered back into text and edited again. Other programs use a string to represent an individual small text item, then they float editable text over the top of the single active item. This can work, but conceptually it is pretty unattractive and often aligning the floater and the background string can be awkward.

The Transmuting Approach

We are obviously going to use objects as far as we can. What is required most often are string objects for the individual small text items. However, at most there will be one editable text, so this will be an editable text object, and any of the string objects can assume this role. What is needed are transmuting objects.

There are to be many string objects, and at most, one of these may be transmuted back and forth to an editable text object as required. The time to transmute is clearly on activation and de-activation, since there is only one editable text at a time (the active one). The only other property required of the objects is the ability to draw themselves, especially when inactive, as might occur during an update. Care must be taken over the drawing, because the pen may have to produce and match exactly the same result when drawing either version of a transmuted object.

Transmutation here amounts to replacing one object with another - perhaps creating one and deleting the other. You would not want to do this with an object that is referred to by other parts of the program, for that might leave dangling references. Caution suggests hiding the transmuted object within a public object - all public references will then be to the public object.

It may be that the editing by the user makes what formerly was a simple label into complex styled text (maybe akin to the opening page of a King James Bible), in which case, the text is not transmuted back to a string on de-activation. Another decision concerns a default style for the labels - each label can have its own, or there could be a global style. The choice is left to the designing programmer.

A Code Example

The code uses Marco Piovanelli's WASTE styled-text engine http://cirrus.sprl.umich.edu/waste/. In a perfect world the code looks something like the following.

class TText : public CAbstractText
    // Abstract text supplies all the other methods
 {
 private:
 TPrivateText  *fInternalText;
 public:
 void   ActivateText (Boolean OnOff);
 void   Compact();
 void   UnCompact();
 virtual void    Update(RgnHandle updateRgn);
 }

void TText::ActivateText (Boolean OnOff)
 {
 if (OnOff)
 {
 UnCompact();    // transmutes from a string, if needed
 FocusToDraw();
 fInternalText->Activate(true);
 }
 else
 {
 FocusToDraw();
 fInternalText->Activate(false);
 Compact(); // attempts to transmute into a string
 }
 }

void TText::Compact()
 {
 Handle itsText;
 TInternalText *newText;
 Point itsPenStart;
 
 if (fInternalText->CanCompact())  {
 itsText= fInternalText->GetText();
 itsPenStart= fInternalText->GetPenStart();
 newText= new TString(itsText,itsPenStart);
 delete fInternalText;
 fInternalText=newText;
 }
 }

void TText::UnCompact()
 {
 Handle itsText;
 TInternalText *newText;
 
 if (fInternalText->CanExpand())   {
 itsText= fInternalText->GetText();
 newText= new TStyledText(itsText);
 delete fInternalText;
 fInternalText=newText;
 }
 }

void TText::Update(RgnHandle updateRgn)
 {
 
 if (RectInRgn(&fBoundingBox, updateRgn))
 {
 FocusToDraw();
 Frame();
 fInternalText->Update(updateRgn);
 }
 } 


class TInternalText  // important fields and methods only
 {
 virtual void    ActivateText (Boolean OnOff) {;};
 virtual Boolean CanCompact() {return false};
 virtual Boolean CanExpand() {return false};
 virtual Handle  GetText();
 virtual Point   GetPenStart(){return PointOf(0,0)};
 virtual void    SetPenStart(Point aStart){;};
 virtual void    Update(RgnHandle updateRgn);
 }

class TString  : public TInternalText
    // important fields and methods only          
 {
 Handle fText;
 Point fPenStart;

 Boolean  CanExpand() {return true};
 Handle GetText() {return fText};
 void   SetPenStart(Point aStart){fPenStart=aStart};
 void   Update(RgnHandle updateRgn);
 }

class TStyledText: public TInternalText
    // important fields and methods only 
 {
 void   ActivateText (Boolean OnOff);
 Boolean  CanCompact();
 virtual Point GetPenStart(){return PointOf(0,0)};
 Handle GetText();
 void   Update(RgnHandle updateRgn);
 }


void TString::Update(RgnHandle updateRgn)
 {
 MoveTo(fPenStart.h,fPenStart.v);
 HLock(fText);   
 DrawText( *fText, 0, GetHandleSize (fText) ); // Toolbox Routine           HUnlock( 
fText );
 }


Boolean TStyledText::CanCompact()
 {
 long oldStart,oldEnd,length;
 long kMaxString=999;
 SignedByte alignment;
 Boolean canDo=false;
 
 length= WEGetTextLength(fMacWE);
 
 WEGetSelection(&oldStart,&oldEnd,fMacWE);
 
 if ((oldEnd-oldStart)<kMaxString) // not too long
 {
 WESetSelection(0,kMaxString,fMacWE);
 
 mode = doFont + doFace + doSize + doColor;
 
 alignment=WEGetAlignment(fMacWE);
 
    // one style
 if ((WEContinuousStyle(&mode, &aStyle, fMacWE)) &&
    // one line
 (WEOffsetToLine(kMaxString, fMacWE)==0) &&  
    // no fancy alignment
 ((alignment== weFlushLeft)
 || (alignment== weFlushDefault))  
 )
 canDo=true;
 
 WESetSelection(oldStart,oldEnd,fMacWE);
 }
else
 return canDo    
 }

Point TStyledText::GetPenStart()
 {
 Point penStart;
 short lineAscent,lineDescent;
 LongRect destRect;
 
 WEGetDestRect(&destRect,fMacWE);  
 
 penStart.h=destRect.left;
 
 _WECalcHeights(0, 1, &lineAscent, &lineDescent, fMacWE);
 
 penStart.v= destRect.top+lineAscent;
 
 return
 penStart
 }

void TStyledText::Update(RgnHandle updateRgn)
 {
 WEUpdate(updateRgn, fMacWE); // passed to the styled text engine
 }

Unfortunately, the real world forced some modifications to this code. The Macintosh styled-text engine and the WASTE styled-text engine were not originally written as objects. They could have been given a wrapper to make them into objects, but normally they are used as Handles to records. This is not much different from Handles to objects. In the practical implementation the internal private text objects are not used. Instead, the fInternalText field is either just a Handle directly to a WASTE record or a handle to the raw text. Strictly speaking, the text transmutes a Handle based internal data structure rather than a Handle based internal object. However, it does work perfectly to produce results like the following sequence.

Figure 1. The top label is active editable text.

Figure 2. Some of the text is obscured (to demonstrate that the drawing routines mesh properly).

At this point, both labels are strings. The first several letters of the top label have been drawn by the text drawing routine.

Figure 3. Text is redrawn by string drawinf routine.

If we move the the obscuring window to one side (Figure 3) we notice that the half ‘e' and the ‘xt' in the top label are drawn perfectly by the string drawing routine and the mesh of half-a-text-draw and half-a-string-draw is exact.

Next, the document and the top label is activated and the ‘xt' changed to Chicago 18. This makes the label styled text, which will not transmute. The text is obscured again. Remove the obscuring window, and there is a perfect redraw of the top label (as styled text) and the bottom label (as a string). (See Figure 4.)

Figure 4. Obscured styled-text redrawn.

Similarly, the document and the bottom label can be activated, the bottom label made into styled text, and the obscuring sequence repeated.

A sceptic might say that the drawing routines here and the end results are visually indistinguishable from one another - how do we know that all this transmutation is actually happening? To see that the code was working properly, a single debugging SysBeep(5) is enclosed with the string drawing routine, and a double SysBeep(5) with the text drawing routine - you can hear the Updates.

 
AAPL
$102.99
Apple Inc.
+0.52
MSFT
$44.38
Microsoft Corpora
-0.50
GOOG
$532.71
Google Inc.
+6.17

MacTech Search:
Community Search:

Software Updates via MacUpdate

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
BBEdit 11.0 - Powerful text and HTML edi...
BBEdit is the leading professional HTML and text editor for the Mac. Specifically crafted in response to the needs of Web authors and software developers, this award-winning product provides a... Read more
Apple Security Update 2014-005 - For OS...
Apple Security Update is recommended for all users and improves the security of Mac OS X. For information on the security content of this update, please visit this website: http://support.apple.com/... Read more
EyeTV 3.6.6 - Watch and record TV on you...
EyeTV brings a rich TV experience to your Mac. Watch live TV on your Mac. Pause, rewind, and record whenever you want. EyeTV gives you powerful control over what you watch and how you watch it. Put... Read more
RapidWeaver 6.0 - 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
NTFS 12.0.39 - Provides full read and wr...
Paragon NTFS breaks down the barriers between Windows and OS X. Paragon NTFS effectively solves the communication problems between the Mac system and NTFS, providing full read and write access to... Read more
RestoreMeNot 2.0.3 - Disable window rest...
RestoreMeNot provides a simple way to disable the window restoration for individual applications so that you can fine-tune this behavior to suit your needs. Please note that RestoreMeNot is designed... Read more
Command-C 1.1.5 - Clipboard sharing tool...
Command-C is a revolutionary app which makes easy to share your clipboard between iOS and OS X using your local WiFi network, even if the app is not currently opened. Copy anything (text, pictures,... Read more
Macgo Blu-ray Player 2.10.9.1750 - Blu-r...
Macgo Mac Blu-ray Player can bring you the most unforgettable Blu-ray experience on your Mac. Overview Macgo Mac Blu-ray Player can satisfy just about every need you could possibly have in a Blu-ray... Read more

Latest Forum Discussions

See All

Super Glyph Quest (Games)
Super Glyph Quest 1.01 Device: iOS Universal Category: Games Price: $2.99, Version: 1.01 (iTunes) Description: Adventure is back Questers! Combine elemental glyphs together to cast powerful spells and vanquish adorable monsters in... | Read more »
Fighting Fantasy: Caverns of the Snow Wi...
Fighting Fantasy: Caverns of the Snow Witch 1.0 Device: iOS Universal Category: Games Price: $5.99, Version: 1.0 (iTunes) Description: Travel to Northern Allansia’s perilous Icefinger Mountains to defeat the wicked Snow Witch in this... | Read more »
Star Warfare 2: Payback Review
Star Warfare 2: Payback Review By Blake Grundman on October 22nd, 2014 Our Rating: :: ONE-TRICK PONYUniversal App - Designed for iPhone and iPad Unfortunately, it doesn’t take long for Star Warfare 2’s free-firing fun to turn into... | Read more »
TinType by Hipstamatic (Photography)
TinType by Hipstamatic 1.0 Device: iOS iPhone Category: Photography Price: $.99, Version: 1.0 (iTunes) Description: Create hauntingly beautiful, soul capturing portraits with TinType by Hipstamatic. Inspired by daguerreotypes,... | Read more »
The Latest Update for Heroes of Dragon A...
The Latest Update for Heroes of Dragon Age Introduces Daily PvE Challenges Posted by Ellis Spice on October 22nd, 2014 [ permalink ] | Read more »
Bee Brilliant Review
Bee Brilliant Review By Jennifer Allen on October 22nd, 2014 Our Rating: :: SAMEY MATCH-3Universal App - Designed for iPhone and iPad Want even more Match-3 gaming and fancy a bee based twist? Bee Brilliant is that game. Don’t... | Read more »
A New Trailer has Been Revealed for Epic...
A New Trailer has Been Revealed for Epic of Kings Posted by Jessica Fisher on October 22nd, 2014 [ permalink ] Dead Mage Inc. has released a new, action-packed trailer for the upcoming Epic of Kings. | Read more »
Find the Line Review
Find the Line Review By Campbell Bird on October 22nd, 2014 Our Rating: :: INSLIDE THE LINESUniversal App - Designed for iPhone and iPad Tease out beautiful line drawings in this unique, free-to-play puzzle game.   | Read more »
Things Get Magical in The Sims FreePlay...
Things Get Magical in The Sims FreePlay with a New Halloween Update Posted by Ellis Spice on October 22nd, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
The Silent Age Episode 2 Review
The Silent Age Episode 2 Review By Jennifer Allen on October 22nd, 2014 Our Rating: :: ROUNDING THINGS OFF NICELYUniversal App - Designed for iPhone and iPad Rounding off a great point and click adventure comes The Silent Age... | Read more »

Price Scanner via MacPrices.net

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
13-inch 2.5GHz MacBook Pro on sale for $100 o...
B&H Photo has the 13″ 2.5GHz MacBook Pro on sale for $999.99 including free shipping plus NY sales tax only. Their price is $100 off MSRP. Read more
Strong iPhone, Mac And App Store Sales Drive...
Apple on Monday announced financial results for its fiscal 2014 fourth quarter ended September 27, 2014. The Company posted quarterly revenue of $42.1 billion and quarterly net profit of $8.5 billion... Read more
Apple Posts How-To For OS X Recovery
OS X 10.7 Lion and later include OS X Recovery. This feature includes all of the tools you need to reinstall OS X, repair your disk, and even restore from a Time Machine backup. OS X Recovery... Read more
Mac OS X Versions (Builds) Supported By Vario...
Apple Support has posted a handy resource explaining which Mac OS X versions (builds) originally shipped with or are available for your computer via retail discs, downloads, or Software Update. Apple... Read more

Jobs Board

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
Position Opening at *Apple* - Apple (United...
…customers purchase our products, you're the one who helps them get more out of their new Apple technology. Your day in the Apple Store is filled with a range of Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.