MACINTOSH C CARBON: A Hobbyist's Guide To Programming the Macintosh in C
Version 1.0
� 2001 K. J. Bricknell

CHAPTER 16

MORE ON WINDOWS

Introduction

As stated at Chapter 4, Mac OS 8.5 introduced a number of new features and associated system software functions to the Window Manager. The new functions associated with zooming and re-sizing windows were addressed at Chapter 4. This chapter addresses the remaining additional features, which include:

• Support for:

  • Floating windows.

  • Window proxy icons.

  • Window path pop-up menus.

  • Transitional window animations and sounds.

• New functions for:

  • Creating and storing windows.

  • Accessing window information.

  • Moving and positioning windows.

  • Associating data with a window.

  • Adding and removing rectangles and regions to and from a window's update region.

  • Setting the colour or pattern of a window's content region.

This chapter also addresses additional features introduced with Carbon and live window resizing introduced with Mac OS X.

Floating Windows

Floating windows are windows that stay in front of all of an application's document windows. They are typically used to display tool, pattern, colour, and other choices to be made available to the user. Examples of floating windows are shown at Fig 1.

In terms of front-to-back ordering, floating windows, unlike document windows, are all basically equal. Unless they actually overlap each other, there is no visual cue of any front-to-back ordering as there is with normal windows (see Fig 1). Because of this equality, floating windows almost always appear in the active state. The exception is when a modal or movable modal dialog or alert is presented to the user. When this occurs, the appearance of all floating windows changes to reflect the inactive state.

Floating Window Types

The sixteen available window types for floating windows are shown at Figs 4 and 5 at Chapter 4.

Opening, Closing, Showing, and Hiding Floating Windows

Floating windows may be created using the function CreateNewWindow (see below) with the constant kFloatingWindowClass passed in the windowClass parameter.

When a floating window is created, it should remain open until the application is closed, and your application should provide the user with a means to hide or show the window as and when required. Ordinarily, it should do this by providing an item in an appropriate menu which allows the user to toggle the window between the hidden and showing states.

A floating window's close box/button should simply hide the window, not close it. For that reason, the close box/button in floating windows should be conceived of as a "hide" box/button rather than as a close box/button.

Floating windows should be hidden when the application receives a suspend event. This is to avoid user confusion arising from one application's floating windows being visible when another application is in the foreground. The application's floating windows should be shown again only when the application receives a subsequent resume event.

In Carbon applications, floating windows are hidden and shown automatically on suspend and resume events. It is thus not necessary for Carbon applications to call HideFloatingWindows and ShowFloatingWindows.

Functions Relating to Floating Windows

The following function is relevant to floating windows:

Utility and Toolbar Windows

Carbon introduced the utility window (a system-wide floating window which floats above all other windows) and the toolbar window, which floats above all document windows in an application but below floating windows. (See Window Class Constants, below.)

Window Proxy Icons

Window proxy icons are small icons displayed in the title bar of document windows. Ordinarily, a specific document file is associated with a specific window, and the proxy icon serves as a proxy for the document file's icon in the Finder.

Proxy icons:

• May be dragged, in the same way that the document's icon in the Finder may be dragged, so as to move or copy the document file.

• Provide visual feedback to the user on the current state of the document. For example, when the document has unsaved changes, your application should cause the proxy icon to be displayed in the disabled state, thus preventing the user from dragging it. (Unsaved documents should not be capable of being moved or copied.)

• Provide visual feedback to the user indicating that the document window is a valid drag-and-drop target. In this case, your application should cause the proxy icon to appear in the highlighted state.

Fig 2 shows a typical window proxy icon for a document in the enabled, disabled, and highlighted states.

At Fig 2, note that, in the drag and drop operation depicted at the right, the window's content area is highlighted along with the proxy icon. Applications typically call the Drag Manager function ShowDragHilite to indicate, with this highlighting, that a window is a valid drag-and-drop target. ShowDragHilite and HideDragHilite highlight and unhighlight the proxy icon as well as the content area.

Changing the State of a Proxy Icon

Applications typically keep track of the modification state of a document so as to, for example, inform users that they has made changes to the document which they might wish to save before closing the document's window. When a document has unsaved changes, your application should call SetWindowModified with true passed in the modified parameter to cause the proxy icon to appear in the disabled state. . (On Mac OS X, this is accompanied by a dot appearing in the middle of the close button.) When the changes have been saved, your application should call SetWindowModified with false passed in the modified parameter to cause the proxy icon to appear in the enabled state.

Handling Mouse-Down Events in a Window Proxy Icon

When a mouse-down event occurs in your application's window, and when FindWindow returns the inProxyIcon result code, your application should simply call TrackWindowProxyDrag. TrackWindowProxyDrag handles all aspects of the drag process while the user drags the proxy icon.

Proxy Icons and File Synchronisation Functions

It is always possible that, while a document file is open, the user may drag its Finder icon to another folder (including the Trash) or change the name of the file via the Finder icon. The application itself has no way of knowing that this has happened and will assume, unless it is informed otherwise, that the document's file is still at its original location with its original name. For this reason applications often include a frequently-called file synchronisation function which synchronises the application with the actual current location (and name) of its currently open document files.

A document's proxy icon is much more prominent to the user than the document's Finder icon. Thus, when proxy icons are used, there is an even a greater possibility that the user will move the file represented by the proxy icon to a different folder while the document is open. The provision of a file synchronisation function is therefore imperative when proxy icons are implemented.

File synchronisation functions are addressed at Chapter 18.

Functions Relating to Window Proxy Icons

The following functions are relevant to window proxy icons:

Note that SetPortWindowPort (or SetPort) should be called to set the relevant window's graphics port as the current port before calling SetWindowProxyCreatorAndType, SetWindowProxyFSSpec, SetWindowProxyAlias, and SetWindowProxyIcon.

Window Path Pop-Up Menus

If your application supports window path pop-up menus, when the user presses the Command key and clicks a window's title, your window displays a pop-up menu containing a standard file system path. The pop-up menu allows the user to open windows for folders along the file system path. An example of a window path pop-up menu is shown at Fig 3.

Displaying and Handling a Window Path Pop-Up Menu

The proxy icon region overlays the title text region which, in turn, overlays the drag region (see Fig 4). Your application must be prepared to respond to a Command-click in either region.

When FindWindow returns the inProxyIcon part code, and TrackWindowProxyDrag returns errUserWantsToDragWindow, your application should proceed on the assumption that the inDrag part code was returned by FindWindow.

When FindWindow returns the inDrag part code, your application should call IsWindowPathSelectClick to determine whether the mouse-down event should activate the window path pop-up menu. If IsWindowPathSelectClick returns true, WindowPathSelect should be called to display the menu.

If the user chooses a menu item for a folder, your application must ensure that the associated window is visible by calling a function which makes the Finder the frontmost process.

Window path pop-up menus are demonstrated at the demonstration program associated with Chapter 18.

Transitional Window Animation and Sounds

On Mac OS 8/9, prior to Mac OS 8.5, the Window Manager supported the playing of a sound to accompany the animation that occured when a user clicked a window's collapse box. Mac OS 8.5 added support for animation and sounds to accompany the hiding and showing of windows.

The function TransitionWindow may be used in lieu of the older functions HideWindow and ShowWindow to hide and show windows. TransitionWindow causes a transitional animation to be displayed, a transitional sound to be played (on Mac OS 8/9), and the necessary update and activate events to be generated.

Creating and Storing Windows

Mac OS 8.5 provides the following functions for creating and storing windows:

Use of the last three of these functions requires a basic understanding of collections, flattened collections and 'wind' resources.

Collections, Flattened Collections, and 'wind' Resources

Collections

A collection object (or, simply, a collection) is an abstract data type that allows you to store multiple pieces of related information.

A collection is like an array in that it contains a number of individually accessible items. However, unlike an array, a collection allows for a variable number of data items and variable-size items. A collection is also similar to a database, in that you can store information and retrieve it using a variety of search mechanisms.

The internal structure of a collection is private. This means that you must store information into a collection and retrieve information from it using Collection Manager functions.

Your application can store a window into a collection using the function StoreWindowIntoCollection. (This applies to any window, not just windows created using the new functions introduced with Mac OS 8.5.) Data associated with the window (for example, text) may also be stored into the same collection.

Using the function CreateWindowFromCollection, you can create a window from collection data. Note that CreateWindowFromCollection creates the window invisibly. After creating the window, you must call the function TransitionWindow to display the window.

Flattened Collections

Using the Collection Manager, you application can create a flattened collection from a collection. A flattened collection is a stream of address-independent data.

The 'wind' Resource

The 'wind' resource consists of an extensible flattened collection. Using the Resource Manager, your application can store a flattened collection, consisting of a window and its data, into a 'wind' resource.

Using the function CreateWindowFromResource, you can create a window from a 'wind' resource. Note that CreateWindowFromResource creates the window invisibly. After creating the window, you must call the function TransitionWindow to display the window.

The CreateNewWindow Function

The function CreateNewWindow creates a window based on the class and attributes you specify in the windowClass and attributes parameters. The following constants may be passed in these parameters.

Window Class Constants

Window Attribute Constants

Note that CreateNewWindow creates the window invisibly. After creating the window, you must call the function TransitionWindow to display the window.

Accessing Window Information

The following functions are provided for accessing window information:

Moving and Positioning Windows

Moving Windows

When your application wishes to move a window for a reason other than a user-instigated drag, it should use the function MoveWindowStructure or the earlier function MoveWindow. MoveWindow repositions a window's content region, whereas MoveWindowStructure repositions a window's structure region.

The function SetWindowBounds provides a means to set the size of a window in addition to simply repositioning it. The size and position of the window are specified in a rectangle passed in the globalBounds parameter. In addition, you may specify whether this rectangle represents the bounds of the content region or the bounds of the structure region by passing either kWindowContentRgn or kWindowStructureRgn in the regionCode parameter. The sister function GetWindowBounds obtains the size and position of the bounding rectangle of the specified window region.

Positioning Windows

Generally speaking, a new window should be placed on the desktop where the user expects it to appear. For new document windows, this usually means just below and to the right of the last document window in which the user was working, although this is not necessarily the case on systems with multiple monitors.

The function RepositionWindow allows you to position a window relative to another window or a display screen. The required window positioning method may be specified by passing one of the following constants in the method parameter.

Window Positioning Constants

These constants should not be confused with the older positioning specification constants (see Chapter 4), and should not be used where those older constants are required (for example, in 'WIND', 'DLOG', and 'ALRT' resources, and in the StandardAlert function).

Associating Data With Windows

The function SetWRefCon has always allowed your application to associate a pointer to data with a reference to a window object. An alternative method of associating data with windows is to use the standard mechanism introduced with Mac OS 8.5. (Both methods, incidentally, are Carbon-compliant.)

The following functions are provided for associating data with windows:

Adding To and Removing From the Update Region

The Mac OS 8.5 Window Manager provided enhanced functions for manipulating the update region. Unlike their pre-Mac OS 8.5 counterparts (InvalRect, InvalRgn, ValidRect, and ValidRgn, which are not included in the Carbon API), the new functions allow the window on which they operate to be explicitly specified, meaning that they do not require the graphics port to be set prior to their use.

The following are the functions for manipulating the update region:

Setting Content Region Colour and Pattern

The following functions set the colour or pattern of a window's content region:

These functions do not affect the graphics port's background colour or pattern.

Window Scrolling

The following functions scroll pixels within a window:

The following constants may be passed in the inOptions parameter of these functions:

Window Menu

Carbon introduced the system-managed Window menu, which is created using the function CreateStandardWindowMenu. After creating the menu you should add it to the menu list using InsertMenu. Menu items containing the titles of your application's windows will be automatically added to, and deleted from, the menu when those windows are created and closed. Floating windows will not be added to the menu.

It is not necessary to set the kWindowInWindowMenuAttribute attribute on your document windows in order for them to be added to the menu. Document windows are automatically given this attribute.

Using SetWindowAlternateTitle you can override the title displayed in the Window menu. You would ordinarily do this if the window title was not expressive enough.

Customising the Window Menu

You can insert your own items to the Window menu by searching for the item with command ID 'wldv' and inserting your items before that item (that is, immediately before the individual window items). 'wldv' is the command ID of the divider that separates the window commands from the individual window items.

A problem here is that, at the time of writing, the divider had the 'wldv' command ID on Mac OS X but not in CarbonLib.

You can append your own items at the end of the Window menu by searching for the item with command ID 'wlst' and appending your items after that item. 'wlst' is the command ID of a hidden menu item that marks the end of the individual window items.

Live Window Resizing

On Mac OS X, windows on which the kWindowLiveResizeAttribute attribute is set support live resizing. When this attribute is set, the window is continually redrawn while it is being resized, as opposed to just outlines of the window, title bar, and resize control being drawn. Full implementation of live resizing requires that the contents of the content region also be continually redrawn as the window is being resized. This requires the use of the Carbon event model.

The demonstration program CarbonEvents2 (Chapter 17) demonstrates live resizing.

Main Constants, Data Types, and Functions

Constants

Window Class

KAlertWindowClass         = 1L
kMovableAlertWindowClass  = 2L
kModalWindowClass         = 3L
kMovableModalWindowClass  = 4L
kFloatingWindowClass      = 5L
kDocumentWindowClass      = 6L
kUtilityWindowClass       = 8L
kHelpWindowClass          = 10L
kSheetWindowClass         = 11L
kToolbarWindowClass       = 12L
kPlainWindowClass         = 13L
kOverlayWindowClass       = 14L
kSheetAlertWindowClass    = 15L
kAltPlainWindowClass      = 16L
kAllWindowClasses         = 0xFFFFFFFF

Window Attributes

kWindowNoAttributes                = 0L
kWindowCloseBoxAttribute           = 1L << 0
kWindowHorizontalZoomAttribute     = 1L << 1
kWindowVerticalZoomAttribute       = 1L << 2
kWindowFullZoomAttribute           = kWindowVerticalZoomAttribute |
                                     kWindowHorizontalZoomAttribute
kWindowCollapseBoxAttribute        = 1L << 3
kWindowResizableAttribute          = 1L << 4
kWindowSideTitlebarAttribute       = 1L << 5
kWindowNoUpdatesAttribute          = 1L << 16
kWindowNoActivatesAttribute        = 1L << 17
kWindowNoShadowAttribute           = 1L << 21
kWindowHideOnSuspendAttribute      = 1L << 24
kWindowStandardHandlerAttribute    = 1L << 25
kWindowHideOnFullScreenAttribute   = 1L << 26
kWindowInWindowMenuAttribute       = 1L << 27
kWindowLiveResizeAttribute         = 1L << 28
kWindowStandardDocumentAttributes  = kWindowCloseBoxAttribute |
                                     kWindowFullZoomAttribute |
                                     kWindowCollapseBoxAttribute |
                                     kWindowResizableAttribute
kWindowStandardFloatingAttributes  = kWindowCloseBoxAttribute |
                                     kWindowCollapseBoxAttribute

Window Positioning

kWindowCenterOnMainScreen                 = 0x00000001
kWindowCenterOnParentWindow               = 0x00000002
kWindowCenterOnParentWindowScreen         = 0x00000003
kWindowCascadeOnMainScreen                = 0x00000004
kWindowCascadeOnParentWindow              = 0x00000005
kWIndowCascadeOnParentWindowScreen        = 0x00000006
kWindowAlertPositionOnMainScreen          = 0x00000007
kWindowAlertPositionOnParentWindow        = 0x00000008
kWindowAlertPositionOnParentWindowScreen  = 0x00000009

Window Transition Action and Effect

kWindowShowTransitionAction  = 1
kWindowHideTransitionAction  = 2
kWindowZoomTransitionEffect  = 1

Window Scrolling

KScrollWindowNoOptions              = 0
KScrollWindowInvalidate             = (1L << 0)
KScrollWindowEraseToPortBackground  = (1L << 1)

Data Types

Property Types

typedef OSType PropertyCreator;
typedef OSType PropertyTag;

Window Class and Attributes

typedef UInt32 WindowClass;
typedef UInt32 WindowAttributes;

Window Positioning

typedef UInt32 WindowPositionMethod;

Window Transitioning

typedef UInt32 WindowTransitionEffect;
typedef UInt32 WindowTransitionAction;

Window Scrolling

typedef UInt32 ScrollWindowOptions;

Functions

Floating Windows

Boolean   AreFloatingWindowsVisible(void);

Window Proxy Icons

OSStatus  SetWindowProxyCreatorAndType(WindowRef window,OSType fileCreator,
          OSType fileType,SInt16 vRefNum);
OSStatus  SetWindowProxyFSSpec(WindowRef window,const FSSpec *inFile);
OSStatus  GetWindowProxyFSSpec(WindowRef window,FSSpec *outFile);
OSStatus  GetWindowProxyAlias(WindowRef window,AliasHandle *alias);
OSStatus  SetWindowProxyAlias(WindowRef window,AliasHandle alias);
OSStatus  SetWindowProxyIcon(WindowRef window,IconRef icon);
OSStatus  GetWindowProxyIcon(WindowRef window,IconRef *outIcon);
OSStatus  RemoveWindowProxy(WindowRef window);
OSStatus  TrackWindowProxyDrag(WindowRef window,Point startPt);

Window Path Pop-Up Menus

Boolean   IsWindowPathSelectClick(WindowRef window,EventRecord *event);
OSStatus  WindowPathSelect(WindowRef window,MenuHandle menu,SInt32 *outMenuResult);

Transitional Window Animations and Sounds

OSStatus  TransitionWindow(WindowRef window,WindowTransitionEffect effect,
          WindowTransitionAction action,const Rect *rect);

Creating and Storing Windows

OSStatus  CreateNewWindow(WindowClass windowClass,WindowAttributes attributes,
          const Rect *bounds,WindowRef *outWindow);
OSStatus  CreateWindowFromResource(SInt16 resID,WindowRef *outWindow);
OSStatus  CreateWindowFromCollection(Collectioncollection,WindowRef *outWindow);
OSStatus  StoreWindowIntoCollection(WindowRef window,Collection collection);

Accessing Window Information

OSStatus  GetWindowClass(WindowRef window,WindowClass *outClass);
OSStatus  GetWindowAttributes(WindowRef window,WindowAttributes *outAttributes);
OSStatus  ChangeWindowAttributes(WindowRef window,WindowAttributes setTheseAttributes,
          WindowAttributes clearTheseAttributes);
Boolean   IsValidWindowRef(GrafPtr grafPort);
WindowRef FrontNonFloatingWindow(void);
OSStatus  FindWindowOfClass(const Point *where,WindowClass inWindowClass,
          WindowRef *outWindow, WindowPartCode *outWindowPart)
WindowRef GetFrontWindowOfClass(WindowClass inWindowClass,Boolean mustBeVisible); 
WindowRef GetNextWindowOfClass(WindowRef inWindow,WindowClass inWindowClass,
          Boolean mustBeVisible);

Moving and Positioning Windows

OSStatus  MoveWindowStructure(WindowRef window,short hGlobal,short vGlobal);
OSStatus  SetWindowBounds(WindowRef window,WindowRegionCode regionCode,
          const Rect *globalBounds);
OSStatus  GetWindowBounds(WindowRef window,WindowRegionCode regionCode,
          Rect *globalBounds);
OSStatus  RepositionWindow(WindowRef window,WindowRef parentWindow,
          WindowPositionMethod method);

Associating Data With Windows

OSStatus  SetWindowProperty(WindowRef window,PropertyCreator propertyCreator,
          PropertyTag propertyTag,UInt32 propertySize,void *propertyBuffer);
OSStatus  GetWindowProperty(WindowRef window,PropertyCreator propertyCreator,
          PropertyTag propertyTag,UInt32 bufferSize,UInt32 *actualSize,
          void *propertyBuffer);
OSStatus  GetWindowPropertySize(WindowRef window,PropertyCreator creator,PropertyTag tag,
          UInt32 *size);
OSStatus  RemoveWindowProperty(WindowRef window,PropertyCreator propertyCreator,
          PropertyTag propertyTag);

Adding To and Removing From the Update Region

OSStatus  InvalWindowRect(WindowRef window,const Rect *bounds);
OSStatus  InvalWindowRgn(WindowRef window,RgnHandle region);
OSStatus  ValidWindowRect(WindowRef window,const Rect *bounds);
OSStatus  ValidWindowRgn(WindowRef window,RgnHandle region);

Setting Content Region Colour and Pattern

OSStatus  SetWindowContentColor(WindowRef window,RGBColor *color);
OSStatus  GetWindowContentColor(WindowRef window,RGBColor *color);
OSStatus  GetWindowContentPattern(WindowRef window,PixPatHandle outPixPat);
OSStatus  SetWindowContentPattern(WindowRef window,PixPatHandle pixPat);

Window Scrolling

OSStatus  ScrollWindowRect(WindowRef inWindow,const Rect *inScrollRect,SInt16 inHPixels,
          SInt16 inVPixels,ScrollWindowOptions inOptions,RgnHandle outExposedRgn);
OSStatus  ScrollWindowRegion(WindowRef inWindow,RgnHandle inScrollRgn,SInt16 inHPixels,
          SInt16 inVPixels,ScrollWindowOptions inOptions,RgnHandle outExposedRgn);

Creating a Window Menu

OSStatus  CreateStandardWindowMenu(OptionBits inOptions,MenuRef *outMenu);
OSStatus  SetWindowAlternateTitle(WindowRef inWindow,CFStringRef inTitle);