Windows and Menus

Inside Macintosh: OpenDoc Class Reference / Part 2 - Types and Constants

Windows and Menus
This section describes the types and constants used in handling windows and menus.

Windows
The following type represents a window structure.

ODPlatformWindow
A 32-bit value identifying a platform-specific window. On the Mac OS, this type is identical to the WindowPtr type.

The following constant identifies a window resource; it is specific to the Mac OS platform.

kODPaletteWDEFID [M]
The resource ID for the 'WDEF' resource for a floating window.

Menus
The following types are used for handling menus. Types marked [M] are specific to the Mac OS platform.

ODCommandID [M]
A 32-bit value representing the command ID associated with a particular menu/item combination. The section "Menu Command IDs" on page 896 describes the constants defined for this type.
ODMenuID
A platform-specific identifier for a menu; on the Mac OS, an identifier of type ODSShort (page 874).
ODMenuItemID
A platform-specific identifier for a menu item; on the Mac OS, an identifier of type ODSShort (page 874).
ODPlatformMenu
A 32-bit value identifying a platform-specific menu; on the Mac OS, this type is identical to the MenuHandle type.
ODPlatformMenuBar
A 32-bit value identifying a platform-specific menu bar; on the Mac OS, this type is identical to the Handle type.

Menu Command IDs
This section describes constants of type ODCommandID (page 895). Most of these constants define the position-independent command IDs for the standard menus and menu items in the base menu bar, as provided by the OpenDoc shell. The remaining constants are used to specify legal ranges for command IDs. Constants marked [M] are specific to the Mac OS platform.
Menus

kODCommandAppleMenu [M]
The Apple menu.
kODCommandDocumentMenu [M]
The Document menu.
kODCommandEditMenu [M]
The Edit menu.
Apple menu items

kODCommandAbout [M]
About Editor, where Editor is the name of the active part editor.
Document menu Items

kODCommandClose [M]
Close.
kODCommandDeleteDocument [M]
Delete Document.
kODCommandDocumentInfo [M]
Document Info.
kODCommandDraft [M]
Drafts.
kODCommandInsert [M]
Insert.
kODCommandNew [M]
New.
kODCommandOpen [M]
Open Selection; applies to a selected frame.
kODCommandOpenDocument [M]
Open Document.
kODCommandPageSetup [M]
Page Setup.
kODCommandPrint [M]
Print.
kODCommandRevert [M]
Revert to Saved.
kODCommandSave [M]
Save.
kODCommandSaveACopy [M]
Save a Copy.
Edit menu items

kODCommandClear [M]
Clear.
kODCommandCopy [M]
Copy.
kODCommandCut [M]
Cut.
kODCommandGetPartInfo [M]
Selection Info, where Selection is "Part" if an embedded frame is selected, "Link" if a link border is selected, or a brief part-specific description if the part's intrinsic content is selected.
kODCommandPaste [M]
Paste.
kODCommandPasteAs [M]
Paste As.
kODCommandPreferences [M]
Editor Preferences, where Editor is the name of the active part editor.
kODCommandRedo [M]
Redo.
kODCommandSelectAll [M]
Select All.
kODCommandUndo [M]
Undo.
kODCommandViewAsWin [M]
View in Window.
Menu ID ranges

kODCommandShellFirst [M]
Lower limit for command IDs defined by the document shell or a container application.
kODCommandShellLast [M]
Upper limit for command IDs defined by the document shell or a container application; lower limit for command IDs defined by part editors.

Undo/Redo Actions
The following types and constants represent information about undo/redo actions.

ODActionData
A structure of type ODByteArray (page 877) whose buffer contains the action data for Undo/Redo commands.
ODActionType
An enumeration specifying the possible values for an undo action.

Constants of this type

kODBeginAction
The action was the first of a multistep action (such as the drag part of a drag-and-drop action).
kODEndAction
The action was the last of a multistep action (such as the drop part of a drag-and-drop action).
kODSingleAction
The action was a single action.

ODDoneState
An enumeration specifying the state of an undo action.

Constants of this type

kODDone
The action was done and is now on the undo stack.
kODRedone
The action was done, undone, and redone and is now back on the undo stack.
kODUndone
The action was done and undone and is now on the redo stack.

ODRespectMarksChoices
An enumeration specifying the possible values for clearing an action history.

Constants of this type

kODDontRespectMarks
Clear the whole action history, ignoring any marks that indicate the beginning of an action subhistory.
kODRespectMarks
Clear only the actions within the current subhistory.