Important: Multilingual Text Engine (MLTE) is deprecated in Mac OS X v10.6 and later. To implement text editing, please use the Cocoa text system instead.
| Framework | Carbon/Carbon.h |
| Declared in | HITextViews.h MacTextEditor.h |
Important: Multilingual Text Engine (MLTE) is deprecated in Mac OS X v10.6 and later. To implement text editing, please use the Cocoa text system instead.
Multilingual Text Engine (MLTE) is an API that allows your application to provide Carbon-compliant Unicode text editing. This document is relevant for anyone who is writing an application that needs to display static Unicode text or provide Unicode-compliant text editing fields. You can also use MLTE if your application provides text editing support within a full-size window. For more information about basic text processing and using MLTE, see the document “Handling Unicode Text Editing with MLTE.”
TXNDrawCFStringTextBox Deprecated in Mac OS X v10.6
TXNDrawUnicodeTextBox Deprecated in Mac OS X v10.6
TXNCreateObject
TXNGetAccessibilityHIObject
TXNDeleteObject
TXNDataSize
TXNAttachObjectToWindowRef
TXNGetWindowRef
TXNGetEventTarget
TXNSetEventTarget
TXNGetCommandEventSupport
TXNSetCommandEventSupport
TXNAdjustCursor
TXNClick
TXNEchoMode
TXNFocus
TXNForceUpdate
TXNGetSleepTicks
TXNIdle
TXNKeyDown
TXNUpdate
TXNScroll
TXNRegisterScrollInfoProc
TXNDrawObject
TXNClear
TXNCopy
TXNCut
TXNIsScrapPastable
TXNPaste
TXNGetData
TXNGetDataEncoded
TXNSetData
TXNCanRedoAction
TXNRedo
TXNCanUndoAction
TXNUndo
TXNCountRunsInRange
TXNGetIndexedRunInfoFromRange
TXNSetTypeAttributes
TXNGetContinuousTypeAttributes
TXNDisposeFontMenuObject Deprecated in Mac OS X v10.5
TXNDoFontMenuSelection Deprecated in Mac OS X v10.5
TXNGetFontMenuHandle Deprecated in Mac OS X v10.5
TXNNewFontMenuObject Deprecated in Mac OS X v10.5
TXNPrepareFontMenu Deprecated in Mac OS X v10.5
TXNGetFontDefaults Deprecated in Mac OS X v10.4
TXNSetFontDefaults Deprecated in Mac OS X v10.4
TXNRecalcTextLayout
TXNSetTXNObjectControls
TXNGetTXNObjectControls
TXNGetLineCount
TXNGetLineMetrics
TXNHIPointToOffset
TXNOffsetToHIPoint
TXNGetViewRect
TXNGrowWindow
TXNResizeFrame
TXNSetBackground
TXNSetFrameBounds
TXNZoomWindow
TXNSetHIRectBounds
TXNGetHIRect
TXNSetScrollbarState
TXNFlattenObjectToCFDataRef
TXNRevert
TXNReadFromCFURL
TXNCopyTypeIdentifiersForRange
TXNWriteRangeToCFURL
TXNGetChangeCount
TXNGetCountForActionType
TXNClearCountForActionType
TXNBeginActionGroup
TXNEndActionGroup
TXNSetActionNameMapper
NewTXNActionNameMapperUPP
InvokeTXNActionNameMapperUPP
DisposeTXNActionNameMapperUPP
NewTXNContextualMenuSetupUPP
InvokeTXNContextualMenuSetupUPP
DisposeTXNContextualMenuSetupUPP
NewTXNFindUPP
InvokeTXNFindUPP
DisposeTXNFindUPP
NewTXNScrollInfoUPP
InvokeTXNScrollInfoUPP
DisposeTXNScrollInfoUPP
This section lists functions that are not recommended and you should no longer use. The Carbon Porting Notes for each function provide information on what you should do in place of using the function.
TXNActivate Deprecated in Mac OS X v10.3
TXNAttachObjectToWindow Deprecated in Mac OS X v10.3
TXNConvertFromPublicScrap Deprecated in Mac OS X v10.3
TXNConvertToPublicScrap Deprecated in Mac OS X v10.3
TXNDraw Deprecated in Mac OS X v10.3
TXNGetRectBounds Deprecated in Mac OS X v10.3
TXNIsObjectAttachedToSpecificWindow Deprecated in Mac OS X v10.3
TXNIsObjectAttachedToWindow Deprecated in Mac OS X v10.3
TXNNewObject Deprecated in Mac OS X v10.3
TXNOffsetToPoint Deprecated in Mac OS X v10.3
TXNPointToOffset Deprecated in Mac OS X v10.3
TXNSetDataFromFile Deprecated in Mac OS X v10.3
TXNSetRectBounds Deprecated in Mac OS X v10.3
TXNTerminateTextension Deprecated in Mac OS X v10.3
TXNSetViewRect Deprecated in Mac OS X v10.2
DisposeTXNActionKeyMapperUPP Deprecated in Mac OS X v10.4
InvokeTXNActionKeyMapperUPP Deprecated in Mac OS X v10.4
NewTXNActionKeyMapperUPP Deprecated in Mac OS X v10.4
TXNCanRedo Deprecated in Mac OS X v10.4
TXNCanUndo Deprecated in Mac OS X v10.4
TXNClearActionChangeCount Deprecated in Mac OS X v10.4
TXNGetActionChangeCount Deprecated in Mac OS X v10.4
TXNSave Deprecated in Mac OS X v10.4
TXNSetDataFromCFURLRef Deprecated in Mac OS X v10.4
This section lists functions that are not supported and cannot be called in Mac OS X.
Disposes of the universal procedure pointer (UPP) to your action name mapper callback function.
void DisposeTXNActionNameMapperUPP ( TXNActionNameMapperUPP userUPP );
The TXNActionNameMapperUPP that is to be disposed of.
See the callback TXNActionNameMapperProcPtr for more information.
MacTextEditor.hDisposes of the universal procedure pointer (UPP) to your contextual menu setup callback function.
void DisposeTXNContextualMenuSetupUPP ( TXNContextualMenuSetupUPP userUPP );
The TXNContextualMenuSetupUPP that is to be disposed of.
See the callback TXNContextualMenuSetupProcPtr for more information.
MacTextEditor.hDisposes of the universal procedure pointer (UPP) to your find callback function.
void DisposeTXNFindUPP ( TXNFindUPP userUPP );
See the callback TXNFindProcPtr for more information.
MacTextEditor.hDisposes of the universal procedure pointer (UPP) to your scrolling callback function.
void DisposeTXNScrollInfoUPP ( TXNScrollInfoUPP userUPP );
See the callback TXNScrollInfoProcPtr for more information.
MacTextEditor.hObtains the background color of the view.
OSStatus HITextViewCopyBackgroundColor ( HIViewRef inTextView, CGColorRef *outColor );
The HITextView associated with the text object whose background color you want to copy.
A CGColorRef representing the color or pattern that is used for drawing the background of the text view. If the returned CGColorRef is not NULL, it is retained on return. You are responsible for releasing this CGColorRef when you are no longer referencing it. If the returned value is NULL, the background is not drawn.
A result code. See “MLTE Result Codes.”
HITextViews.hCreates an HITextView that is initially invisible.
OSStatus HITextViewCreate ( const HIRect *inBoundsRect, OptionBits inOptions, TXNFrameOptions inTXNFrameOptions, HIViewRef *outTextView );
The bounding box of the view. Pass NULL, if you want to initialize the bounds of the view to 0.
Reserved for future use; you must pass 0.
The frame options you want to set for the text view.
On output, points to the newly-created text view.
A result code. See “MLTE Result Codes.”
An HITextView is an MLTE text view that can be embedded in the HIView hierarchy. The view can be embedded in an HIScrollView if you want scroll bars and can also be used in a composited window. For more information on HIView, see the document Introducing HIView, available from the Apple Developer Documentation website.
When you call the function HITextViewCreate to create a text view, an MLTE text object (TXNObject) is allocated and attached to the text view. You can extract the text object by calling the function HITextViewGetTXNObject. You can supply the extracted text object as a parameter to many of the MLTE functions that take a text object as a parameter. However, not all MLTE functions that take a text object can operate on an MLTE object that comes from an HITextView. In general, you cannot use MLTE functions that may alter the geometry of the object or explicitly invoke drawing. If you do, the function returns the result code kTXNDisabledFunctionalityErr.
The following MLTE functions return an error if you pass a text object that comes from an HITextView:
HITextViews.hObtains the text object associated with an HITextView.
TXNObject HITextViewGetTXNObject ( HIViewRef inTextView );
The HITextView associated with the text object you want to retrieve.
Returns the text object associated with the given view.
You can supply the extracted text object as a parameter to many of the MLTE functions that take a text object as a parameter. However, not all MLTE functions that take a text object can operate on an MLTE object that comes from an HITextView. In general, you cannot use MLTE functions that may alter the geometry of the object or explicitly invoke drawing. If you do, the function returns the result code kTXNDisabledFunctionalityErr. See HITextViewCreate for a list of the functions that return an error if you pass a text object that comes from an HITextView.
HITextViews.hSets the background color of the view.
OSStatus HITextViewSetBackgroundColor ( HIViewRef inTextView, CGColorRef inColor );
The HITextView whose background color is to be set.
A CGColorRef representing the color or pattern that is to fill the background of the text view. The CGColorRef is retained by this function. If the text view already contains a background color, it is released prior to the new color being retained. If inColor is NULL, the background of the text view will not draw.
A result code. See “MLTE Result Codes.”
This function allows you to provide alpha.
HITextViews.hCalls your action name mapper callback function.
CFStringRef InvokeTXNActionNameMapperUPP ( CFStringRef actionName, UInt32 commandID, void *inUserData, TXNActionNameMapperUPP userUPP );
The action name.
The command ID of the menu item that is to be mapped.
A pointer to user-defined data that will be passed to your action name mapper callback.
The callback function that is to be called. For more information, see NewTXNActionNameMapperUPP.
A CFStringRef.
MacTextEditor.hCalls your contextual menu setup callback function.
void InvokeTXNContextualMenuSetupUPP ( MenuRef iContextualMenu, TXNObject object, void *inUserData, TXNContextualMenuSetupUPP userUPP );
The contextual menu.
The TXNObject for which the contextual menu is to be displayed.
A pointer to user-defined data that will be passed to your contextual menu setup callback.
The callback function that is to be called. For more information, see NewTXNContextualMenuSetupUPP.
MacTextEditor.hCalls your find callback function.
OSStatus InvokeTXNFindUPP ( const TXNMatchTextRecord *matchData, TXNDataType iDataType, TXNMatchOptions iMatchOptions, const void *iSearchTextPtr, TextEncoding encoding, TXNOffset absStartOffset, ByteCount searchTextLength, TXNOffset *oStartMatch, TXNOffset *oEndMatch, Boolean *ofound, URefCon refCon, TXNFindUPP userUPP );
A result code. See “MLTE Result Codes.”
You can call an invoke function rather than calling your routine directly if you want to support code portability across compiler targets. See the callback TXNFindProcPtr for parameter descriptions and other information.
MacTextEditor.hCalls your scrolling callback function.
void InvokeTXNScrollInfoUPP ( SInt32 iValue, SInt32 iMaximumValue, TXNScrollBarOrientation iScrollBarOrientation, SRefCon iRefCon, TXNScrollInfoUPP userUPP );
You can call an invoke function rather than calling your routine directly if you want to support code portability across compiler targets. See the callback TXNScrollInfoProcPtr for parameter descriptions and other information.
MacTextEditor.hCreates a new universal procedure pointer (UPP) to an action name mapper callback function.
TXNActionNameMapperUPP NewTXNActionNameMapperUPP ( TXNActionNameMapperProcPtr userRoutine );
The action name mapper callback function for which a UPP is to be created.
A universal procedure pointer.
See the callback TXNActionNameMapperProcPtr for more information.
MacTextEditor.hCreates a new universal procedure pointer (UPP) to a contextual menu setup callback function.
TXNContextualMenuSetupUPP NewTXNContextualMenuSetupUPP ( TXNContextualMenuSetupProcPtr userRoutine );
The contextual menu setup callback function for which a UPP is to be created.
A universal procedure pointer.
For more information, see the callback TXNContextualMenuSetupProcPtr.
MacTextEditor.hCreates a new universal procedure pointer (UPP) to a find callback function that uses your criteria for matching.
TXNFindUPP NewTXNFindUPP ( TXNFindProcPtr userRoutine );
A universal procedure pointer.
See the callback TXNFindProcPtr for more information.
MacTextEditor.hCreates a new universal procedure pointer (UPP) to a scrolling callback function.
TXNScrollInfoUPP NewTXNScrollInfoUPP ( TXNScrollInfoProcPtr userRoutine );
A universal procedure pointer.
See the callback TXNScrollInfoProcPtr for more information.
MacTextEditor.hObtains the current cursor position and draws the cursor in a form appropriate to the content over which it is placed.
void TXNAdjustCursor ( TXNObject iTXNObject, RgnHandle ioCursorRgn );
The text object that identifies the text area for which MLTE should adjust the cursor.
A handle to a region created by your application. Pass NULL if you do not want TXNAdjustCursor to provide information about the cursor position to your application. If you do want to obtain the cursor’s current position, pass a valid region handle in this parameter. If you pass a valid region handle and the cursor is over the text area or its scroll bars, on return TXNAdjustCursor sets the region to a 2-pixel by 2-pixel square, centered on the cursor’s hot spot. If the cursor is not over the text area or its scroll bars, or if you have passed NULL, TXNAdjustCursor does not adjust the input value.
If the cursor is over a text area, TXNAdjustCursor sets the cursor to an I-beam. If the cursor is over graphics, a sound file, a movie, a scroll bar, or outside of a window, TXNAdjustCursor sets the cursor to an arrow. Before you call the TXNAdjustCursor function, you should make sure that the window belongs to your application.
You can pass the region handle returned by the TXNAdjustCursor function in the ioCursorRgn parameter to the WaitNextEvent function; this ensures that you receive mouse-moved events if the cursor moves outside that region. If you then receive a mouse-moved event, you can call TXNAdjustCursor again to ensure that the cursor type is appropriate to its new position. Alternately, to ensure that the cursor is adjusted correctly, you can simply call TXNAdjustCursor with every event that your application receives.
MacTextEditor.hAttaches a text object to a window.
OSStatus TXNAttachObjectToWindowRef ( TXNObject iTXNObject, WindowRef iWindowRef );
The text object with which you want to associate the window. You can call the function TXNCreateObject to allocate a text object.
A WindowRef that specifies the window to which you want to attach the text object.
A result code. See “MLTE Result Codes.” Returns paramErr if the text object that you pass is invalid.
MacTextEditor.hStarts an action group.
OSStatus TXNBeginActionGroup ( TXNObject iTXNObject, CFStringRef iActionGroupName );
The text object for which an action group is to be started.
A client-supplied string that is to be used to describe the action group.
A result code. See “MLTE Result Codes.” The error kTXNOperationNotAllowedErr is returned if an undo action group has already been started but has not yet terminated.
Every supported edit action after TXNBeginActionGroup is called is added to the group untilTXNCanUndoAction is called. When MLTE receives an undo or redo command, it treats all actions added to the group as a single operation to undo or redo. Nesting of groups is not allowed. Calling TXNBeginActionGroup twice without calling TXNCanUndoAction in between results in an error. If an action group is active, TXNCanUndoAction and TXNCanRedoAction return false.
MacTextEditor.hIndicates whether an action can be redone.
Boolean TXNCanRedoAction ( TXNObject iTXNObject, CFStringRef *oActionName );
The text object having an action that is to be queried.
On input, a pointer a CFStringRef that, on return, contains the name of the action that can be redone, if there is one. The returned string is either a string defined by MLTE or the string that you passed to TXNBeginActionGroup to create a new action group. You are responsible for retaining and releasing the string. Pass NULL if you don’t want to receive the name of the action.
A Boolean whose value is true if the last action can be redone; you should enable the Redo item in the Edit menu, if there is one. If this function returns false, the last action cannot be redone and you should not enable the Redo item in the Edit menu.
This function tells the client whether the current item on the undo stack is redoable and is usually used to determine whether the Redo item in the Edit menu should be enabled. This function optionally obtains the action name that should be used in the Redo item. When the current undo item is an action group, the string used to name the group is returned. For information on action groups, see TXNBeginActionGroup and TXNEndActionGroup.
MacTextEditor.hIndicates whether an action can be undone.
Boolean TXNCanUndoAction ( TXNObject iTXNObject, CFStringRef *oActionName );
The text object having an action that is to be queried.
On input, a pointer a CFStringRef that, on return contains the name of the action that can be undone, if there is one. The returned string is either a string defined by MLTE or the string that you passed to TXNBeginActionGroup to create a new action group. You are responsible for retaining and releasing the string. Pass NULL if you don’t want to receive the name of the action.
A Boolean whose value is true if the last action can be undone; you should enable the Undo item in the Edit menu, if there is one. If this function returns false, the last action cannot be undone and you should not enable the Undo item in the Edit menu.
This function is usually used to determine whether the Undo item in the Edit menu should be enabled and to obtain the action name that should be used in that item. When the last action is an action group, the string used to name the group is returned.
If you have asked MLTE to handle updating for the Redo and Undo commands in the Edit menu, you should call TXNSetActionNameMapper after calling TXNCanUndoAction so that MLTE can call back to get the correct strings for those items.
MacTextEditor.hDeletes the current selection.
OSStatus TXNClear ( TXNObject iTXNObject );
The text object for the current text area.
A result code. See “MLTE Result Codes.”
To remove a selected object from a text area, a user can either press the Delete key or choose Clear from the Edit menu. Before you call the TXNClear function, you can use the TXNIsSelectionEmpty function to determine whether any text is selected. Unlike the function TXNCut, the TXNClear function does not add the deleted selection to the private MLTE scrap.
MacTextEditor.hSets the counter for the specified action type to zero.
OSStatus TXNClearCountForActionType ( TXNObject iTXNObject, CFStringRef iActionTypeName );
The text object having one or more counters that are to be set to zero.
The action type for which the counter is to be set to zero. This parameter can be a string that was passed to TXNBeginActionGroup or one of the constants described inAction Constants.
A result code. See “MLTE Result Codes.”
MacTextEditor.hProcesses a mouse-down event in a window’s content area.
void TXNClick ( TXNObject iTXNObject, const EventRecord *iEvent );
The text object in which the mouse-down event occurred.
A pointer to the event record that contains the mouse-down event to process.
When you pass the event to the TXNClick function, it responds to the user’s action by scrolling, selecting text, playing a sound or movie, handling a drag–and-drop operation, or responding to a double- or triple-click, as appropriate. Before you call TXNClick, you should make sure that the front window belongs to your application.
MacTextEditor.hCopies the current selection to the private MLTE scrap.
OSStatus TXNCopy ( TXNObject iTXNObject );
The text object for the current text area.
A result code. See “MLTE Result Codes.”
You can use the TXNCopy function to respond to a user-requested copy action. Before you call TXNCopy, you can use the TXNIsSelectionEmpty function to determine whether any text is selected.
The TXNCopy function copies the current selection to the MLTE scrap. In a Carbon application, the Scrap Manager automatically converts your application’s private scrap to the Clipboard so it is available to other applications. In a Classic application, you must call the function TXNConvertToPublicScrap after you call TXNCopy.
MacTextEditor.hObtains an array of universal type identifiers for a TXNObject.
OSStatus TXNCopyTypeIdentifiersForRange ( TXNObject iTXNObject, TXNOffset iStartOffset, TXNOffset iEndOffset, CFArrayRef *oTypeIdentifiersForRange );
The text object.
The starting offset in iTXNObject.
The ending offset in iTXNObject.
A pointer to a CFArrayRef. On return, the array contains the list of universal type identifiers that MLTE supports. Each entry in the array is a CFStringRef.
A result code. See “MLTE Result Codes.”
Some file formats support limited embedding of data when writing to disk, and use attachments, such as Rich Text Format (RTF), instead.
Use this function to get a list of universal type identifiers that can be used when calling TXNWriteRangeToCFURL to write the object out to disk with no data loss. Note that support for new document formats could be added in the future.
MacTextEditor.hObtains a count of the style runs in a range of data.
OSStatus TXNCountRunsInRange ( TXNObject iTXNObject, TXNOffset iStartOffset, TXNOffset iEndOffset, ItemCount *oRunCount );
The text object for the current text area.
The beginning offset of the range of data in the document that you want to examine. Note that this offset is a generic counter of elements (such as characters, pictures, and movies), not an offset into memory.
The ending offset of the range of data in the document that you want to examine. Note that this offset is a generic counter of elements, not an offset into memory.
On return, a pointer to the number of style runs in the specified range.
A result code. See “MLTE Result Codes.”
Given a range of data in a document that is specified by a starting and ending offset, you can use the TXNCountRunsInRange function to obtain a count of the changes in text styles, graphics, movies, or sounds in that range. Once you have a run count, you can supply this information to the function TXNGetIndexedRunInfoFromRange in order to obtain information about the runs themselves.
Offsets in MLTE are always character offsets.
MacTextEditor.hCreates a new MLTE text object which is an opaque structure that handles text formatting at the document level.
OSStatus TXNCreateObject ( const HIRect *iFrameRect, TXNFrameOptions iFrameOptions, TXNObject *oTXNObject );
A pointer to a rectangle used to specify the destination and view rectangles for the text object. Pass NULL if you want to use the window port rectangle as the view and destination rectangles when the object is attached later to a window. See the function TXNAttachObjectToWindowRef.
A value that specifies the options you want the frame to support. See Frame Option Masks for a description of possible values.
On input, a pointer to a structure of type TXNObject. On output, points to the opaque text object data structure allocated by the function. You need to pass this object to most MLTE functions.
A result code. See “MLTE Result Codes.”
For each document, a new text object is allocated by the TXNCreateObject function and returned in the oTXNObject parameter. The object is allocated only if no errors occur. If there is an error during the allocation process, MLTE frees the text object.
If you are writing a text editing application, you may want to call the TXNCreateObject function when the application launches (a new document will be displayed) and whenever the user selects New from the File menu. In addition, many MLTE functions require you to pass a text object.
If you want to create a read-only document, you need to pass the option kTXNReadOnlyMask in the iFrameOptions parameter. Note that this option puts the text object into a state that does not allow user input. However, your application can put data into the text object by calling the function TXNSetData. If you want the text object set into a more restrictive read-only state that does not allow user input or your application to put data into the text object programmatically, you need to call the function TXNSetTXNObjectControls, passing the tag kTXNIOPrivilegesTag. If you choose to set the text object into this restrictive state, you will get an error if you try to call the function TXNSetData on the text object. (In this case, you can change the text object to a less restrictive state by calling TXNSetTXNObjectControls, passing the tag kTXNNoUserIOTag.)
Because of how MLTE uses Carbon events internally, the window in which the document is displayed must have the standard event handlers installed. You can install standard event handlers in one of the following ways:
When you create the window, add the attribute kWindowStandardHandlerAttribute to the window. See Window Manager Reference for more information.
Call the Carbon Event Manager function InstallStandardEventHandler on the window's event target. See Handling Carbon Events for more information.
MacTextEditor.hDeletes the current selection and copies it to the private MLTE scrap.
OSStatus TXNCut ( TXNObject iTXNObject );
The text object for the current text area.
A result code. See “MLTE Result Codes.”TXNCut also returns Scrap Manager errors.
You can use the TXNCut function to respond to a user-requested cut action. Before you call TXNCut, you can use the TXNIsSelectionEmpty function to determine whether any text is selected. The TXNCut function deletes the current selection and then copies it to the private MLTE scrap. In a Carbon application, the Scrap Manager automatically converts your application’s private scrap to the Clipboard so it is available to other applications. In a Classic application, you must call the function TXNConvertToPublicScrap after you call TXNCut to move the selection to the Clipboard.
MacTextEditor.hReports the amount of memory used to hold the text in a given text object.
ByteCount TXNDataSize ( TXNObject iTXNObject );
The text object that you want to examine.
The number of bytes required to hold the characters.
You can use this function to determine how large a handle should be if, for example, you copy text. Note that because every individual sound, picture, or movie in a text object is represented by a single character in the text buffer, the TXNDataSize function returns a value that does not necessarily represent the true size of any non-text data.
If you are using Unicode and you want to know the number of characters, divide the returned ByteCount value by sizeof(UniChar) or 2, since MLTE uses the 16-bit Unicode Transformation Format (UTF-16).
MacTextEditor.hDeletes a previously allocated text object.
void TXNDeleteObject ( TXNObject iTXNObject );
The text object you want to delete.
You should call the TXNDeleteObject function when you close the window associated with a text object. The function TXNDeleteObject releases the specified text object and all associated data structures from memory. If the object has multiple frames, all frames are deleted.
Multiple frames are not yet implemented in MLTE.
MacTextEditor.hHandles dragged data in a text object for which a custom drag handler is already in place.
OSErr TXNDragReceiver ( TXNObject iTXNObject, TXNFrameID iTXNFrameID, WindowRef iWindow, DragReference iDragReference, Boolean iDifferentObjectSameWindow );
The text object that is receiving the dragged data.
The frame ID of the text object that is receiving the dragged data. You obtain a TXNFrameID when you create a text object with the TXNNewObject function.
A pointer to the window containing the text object that is receiving the dragged data. You obtain this pointer from the appropriate Drag Manager function.
The drag reference you want MLTE to handle. You obtain a drag reference by calling the appropriate Drag Manager function.
A Boolean value. Pass true if the drag operation is in the same window that it started in, but in a different text object within that window. If there is only one text object in a window, you should always pass false. You should also pass false if the drag operation has moved into a different window than the one in which it originated. You can determine whether the drag operation has left the originating window by calling the Drag Manager function GetDragAttributes.
A result code. See “MLTE Result Codes.” A Drag Manager result code.
You would not typically use the TXNDragReceiver function, because MLTE provides basic drag management for you.
However, you might call TXNDragReceiver if your application needs to examine the dragged data prior to MLTE handling it, or if you have multiple text objects in a window, or if you have your own drag management infrastructure that you want to use.
You must inform MLTE that you wish to handle some aspect of the drag process by passing the TXNFrameOptions value kTXNDoNotInstallDragProcsMask in the iFrameOptions parameter of TXNNewObject. If you do so, you are responsible for calling the drag handlers for the drag operation. Then, you should call TXNDragReceiver when your drag receiver is called and you want MLTE to take over control of the drag reception process.
When you call TXNDragReceiver, MLTE takes over the drag operation and handles everything from that point onward. This includes determining whether the text object is a valid drop target and if the dragged data is an MLTE-supported type, as well as managing the addition of the dragged data to the text object.
MacTextEditor.hHandles tracking a drag event in a text object for which a custom drag handler is already in place.
OSErr TXNDragTracker ( TXNObject iTXNObject, TXNFrameID iTXNFrameID, DragTrackingMessage iMessage, WindowRef iWindow, DragReference iDragReference, Boolean iDifferentObjectSameWindow );
The text object in which you need to track a drag event.
The frame ID of the text object in which you need to track a drag event. You obtain a TXNFrameID when you create a text object with the TXNNewObject function.
A drag message obtained from the appropriate Drag Manager function.
A pointer to the window containing the text object in which you need to track a drag event. You obtain this pointer from the appropriate Drag Manager function.
The drag reference that you want MLTE to handle. You obtain a drag reference by calling the appropriate Drag Manager function.
A value of type Boolean. If your application displays more than one text object per window, pass true when the drag operation moves out of one object’s view rectangle and into another text object’s view rectangle.
A result code. See “MLTE Result Codes.” A Drag Manager result code.
You would not typically use the TXNDragTracker function, because MLTE provides basic drag management for you.
However, you might call TXNDragTracker if your application needs to examine the dragged data prior to MLTE handling it, or if you have multiple text objects in a window, or if you have your own drag management infrastructure that you want to use.
You must inform MLTE that you wish to handle some aspect of the drag process by passing the TXNFrameOptions value kTXNDoNotInstallDragProcsMask in the iFrameOptions parameter of TXNNewObject. If you do so, you are responsible for calling the drag handlers for the drag operation. Then, you should call TXNDragTracker when your drag tracker is called and you want MLTE to take over control of the drag tracking process.
MacTextEditor.hDraws a text object in the last window set by your application.
OSStatus TXNDrawObject ( TXNObject iTXNObject, const HIRect *iClipRect, TXNDrawItems iDrawItems );
The text object you want to draw. You can call the function TXNCreateObject to allocate a text object.
A pointer to an HIRect data structure. If the rectangle is NULL MLTE uses the view rectangle when drawing. Otherwise, MLTE uses the rectangle that is the intersection of the iClipRect rectangle and the view rectangle.
A Draw Items Masks value that specifies which elements are drawn. Pass kTXNDrawItemScrollbarsMask if you want the scroll bars drawn; kTXNDrawItemTextMask to render the text; kTXNDrawItemTextAndSelectionMask to render the text and the current selection, and kTXNDrawItemAllMask to draw the scroll bars, text, and the current selection.
This function has no effect for text objects that have the visibility tag set to false.
MacTextEditor.hDetermines whether a specified character is drawn instead of the glyph associated with the input character.
OSStatus TXNEchoMode ( TXNObject iTXNObject, UniChar iEchoCharacter, TextEncoding iEncoding, Boolean iOn );
The text object for the current text area.
A value that specifies the substitute character.
The text encoding from which the substitute character is drawn. See the Text Encoding Conversion Manager reference documentation for a discussion of the text encoding data type and of possible text encoding values.
A Boolean value. Pass true to turn on character substitution. Pass false to turn it off. When you enable character substitution for a text object, all characters in the text area have the character specified by the iEchoCharacter parameter substituted for the actual glyph when MLTE draws the text.
A result code. See “MLTE Result Codes.”
You can use the TXNEchoMode function when you want to hide what the user types, such as a password in a login dialog box.
The substitution character is a UniChar data type to facilitate passing any 2-byte character. The encoding parameter actually determines the encoding MLTE uses to locate a font and display a character. Thus if you want to display the diamond character from the Shift-JIS encoding for Mac OS, you would pass the value 0x86A6 for the character, but pass an encoding value that represents Mac OS Japanese encoding.
MacTextEditor.hEnds an action group.
OSStatus TXNEndActionGroup ( TXNObject iTXNObject );
The text object for which an action group is to be ended.
A result code. See “MLTE Result Codes.”
The call is ignored if there is no active action group.
MacTextEditor.hFinds a piece of text or a graphics, sound, or movie object.
OSStatus TXNFind ( TXNObject iTXNObject, const TXNMatchTextRecord *iMatchTextDataPtr, TXNDataType iDataType, TXNMatchOptions iMatchOptions, TXNOffset iStartSearchOffset, TXNOffset iEndSearchOffset, TXNFindUPP iFindProc, SRefCon iRefCon, TXNOffset *oStartMatchOffset, TXNOffset *oEndMatchOffset );
The text object to be searched.
A pointer to a data structure that contains the text to match, the length of that text, and the text’s encoding. Pass NULL if you are looking for a graphics, sound, or movie object.
The type of data for which you want to search. See Supported Data Types for a description of possible values. If the data type is kTXNPictureFile, kTXNMovieFile, or kTXNSoundFile, the default behavior is to match on any nontext object. If you want to find a specific data type, you can provide a custom find callback or ignore types that do not match what you want to find.
The matching rules to use in the find operation. See Search Criteria Masks for a description of possible values.
The offset at which the search should begin. You can use kTXNStartOffset if you want to search from the start of the object’s data.
The offset at which the search should end. You can use kTXNEndOffset if you want to search to the end of the object’s data.
The custom callback you want used in place of the default matching behavior. You can pass NULL if you want to use the default matching behavior.
An signed 32-bit integer. You can use this for whatever your application needs. It is passed to the custom callback specified by iFindProc.
On return, a pointer to the absolute offset that identifies the start of the match. It is set to a value of kTXNUseCurrentSelection if there is no match.
On return, a pointer to the absolute offset that identifies the end of the match. It is set to a value of kTXNUseCurrentSelection if there is no match.
A result code. See “MLTE Result Codes.”
By default, text is matched on the basis of a binary comparison. If you set the iMatchOptions variable to ignore case, the characters to be searched are duplicated and case neutralized. If the want to search a large amount of text, a case insensitive search can fail due to insufficient memory.
If you set the iMatchOptions variable to find an entire word, then once a match is found, the matched text is tested to see if it is a word. If the kTXNUseEncodingWordRulesBit is set, then the Script Manager FindWord function is called to make this determination. If the text being searched is Unicode text, then the ATSUI word-determining functions are used to test for a word.
If the application is looking for a nontext type, then each nontext type in the document is returned. The iFindProc parameter lets you provide a more elaborate search engine (such as a regular expression processor) should you need one.
Offsets in MLTE are always character offsets.
MacTextEditor.hFlattens a text object so it can be saved to disk or embedded with other data.
OSStatus TXNFlattenObjectToCFDataRef ( TXNObject iTXNObject, TXNDataType iTXNDataType, CFDataRef *oDataRef );
The text object that identifies the document you want to flatten. You can either call the function TXNCreateObject to allocate a text object or you can call the function HITextViewGetTXNObject to obtain the text object associated with an HITextView.
A value that specifies the format in which the data is written out.
On input, points to a structure of type CFDataRef. On output, points to a flattened version of the text object in the format specified by the iTXNDataType parameter. You are responsible to retain the returned CFDataRef.
A result code. See “MLTE Result Codes.”
This function supports the following data types:
kTXNTextData, for text data.
kTXNUnicodeTextData, for plain UTF-16.
kTXNTextAndMultimediaData, for data in MLTE format.
kTXNRichTextFormatData, for data in RTF format.
MacTextEditor.hChanges the focus of a text object.
void TXNFocus ( TXNObject iTXNObject, Boolean iBecomingFocused );
The text object whose focus you want to change.
If you pass true, the text object receives focus. This means the current selection or insertion point is active, text input appears at the insertion point, and the keyboard and font are synchronized. (Note that the font and keyboard are synchronized only if keyboard synchronization is enabled. See Keyboard Synchronization Settings.) If the scroll bars are not already active, they are activated. If you pass false, the text object’s current selection or insertion point is inactive.
You should use the TXNActivate function to make scroll bars active while text input is not focused. This behavior is often desirable for windows with multiple text areas that are scrollable.
MacTextEditor.hForces an update of the view rectangle and the scroll bars.
void TXNForceUpdate ( TXNObject iTXNObject );
The text object you want to update.
This function operates similarly to the Window Manager functions InvalRect and InvalRgn. For example, when the user increases the size of a window that contains text from a text object, the TXNForceUpdate function adds the new region (including two rectangles formerly occupied by the scroll bars in the smaller content area) to the update region.
MacTextEditor.hObtains an HIObjectRef representing the MLTE object for accessibility purposes.
OSStatus TXNGetAccessibilityHIObject ( TXNObject iTXNObject, HIObjectRef *oHIObjectRef );
The text object.
On input, a pointer an HIObjectRef that, on return, represents the text object specified by iTXNObject as an accessible object.
A result code. See “MLTE Result Codes.”
For each MLTE object that a view creates, the view needs to call this function to get an HIObjectRef that can be used to represent the MLTE object as an accessible object.
After the view gets this HIObjectRef, it must add the HIObjectRef as a child of itself. The accessibility engine then routes events to MLTE accessible objects automatically.
The view must install Carbon Event handlers for kEventAccessibleGetAllAttributeNames and kEventAccessibleGetNamedAttribute, using the HIObjectRef as the target, to provide information for at least the following required attributes:
kAXRoleAttribute
kAXRoleDescriptionAttribute
kAXWindowAttribute
kAXPositionAttribute
kAXSizeAttribute
MLTE also installs handlers for kEventAccessibleGetAllAttributeNames and kEventAccessibleGetNamedAttribute. Note that these handlers are not called unless the client-installed handlers return eventNotHandledErr. These handlers return information for the following attributes:
kAXEnabledAttribute
kAXFocusedAttribute
kAXValueAttribute
kAXSelectedTextAttribute
kAXSelectedTextRangeAttribute
kAXNumberOfCharactersAttribute
kAXLineForIndexParameterizedAttribute
kAXRangeForLineParameterizedAttribute
kAXStringForRangeParameterizedAttribute
kAXRangeForPositionParameterizedAttribute
kAXRangeForIndexParameterizedAttribute
kAXBoundsForRangeParameterizedAttribute
kAXStyleRangeForIndexParameterizedAttribute
MacTextEditor.hRetrieves the number of times a document has been changed.
ItemCount TXNGetChangeCount ( TXNObject iTXNObject );
The text object whose changes you want to count.
The total number of changes since the document was last saved. If the document is new, the number of changes since it was created.
The change count increments for every executed command such as Cut or Copy. An uninterrupted sequence of key-down events increments the count by 1. The count is cleared each time the text object is saved. You can use this function to determine if your application should make the Save item in the File menu active.
MacTextEditor.hObtains the command event support that is currently set for an MLTE object.
OSStatus TXNGetCommandEventSupport ( TXNObject iTXNObject, TXNCommandEventSupportOptions *oOptions );
The text object.
A pointer to a value of type TXNCommandEventSupportOptions that, on return, contains the option settings for the text object specified by iTXNObject. For possible values, see Command Event Support Options.
A result code. See “MLTE Result Codes.”
MacTextEditor.hChecks to see if the attributes of the current selection are continuous.
OSStatus TXNGetContinuousTypeAttributes ( TXNObject iTXNObject, TXNContinuousFlags *oContinuousFlags, ItemCount iCount, TXNTypeAttributes ioTypeAttributes[] );
The text object that contains the current selection.
On return, a pointer to a value that specifies whether text attributes are continuous. See Continuous Style Information Masks for a description of possible values. If a particular bit is set and if your application has passed a tag value in a TXNTypeAttributes structure in the array that corresponds to the bit, then your application should display a check mark next to the appropriate menu item.
The number of TXNTypeAttributes structures in the ioTypeAttributes array.
An array of TXNTypeAttributes structures. The tag values in this array indicate the text attributes in which the application is interested. It cannot be NULL. If you are using ATSUI and you want to know the ATSUI font ID, you should set the tag field to kATSUFontTag, which is a constant in ATSUnicode.h. If you are using ATSUI and you set the tag field to a QuickDraw font ID, then the QuickDraw font to which the ATSUI font maps is returned. Note that this is not always the same font since many ATSUI fonts are not supported by QuickDraw.
A result code. See “MLTE Result Codes.”
You can use this function to determine whether your application should display check marks in the Font, Style, Size, and Color menus. If these are the only attributes in which you are interested, you can use this function on systems that use QuickDraw or Apple Type Services for Unicode Imaging (ATSUI).
MacTextEditor.hGets the number of times a given type of action has occurred.
OSStatus TXNGetCountForActionType ( TXNObject iTXNObject, CFStringRef iActionTypeName, ItemCount *oCount );
The text object to query.
The action type that is to be included when retrieving the count. This parameter can be the string that was passed to TXNBeginActionGroup or one of the constants described in Action Constants.
On return, the number of times the action specified by iActionTypeName has occurred.
A result code. See “MLTE Result Codes.”
Call TXNClearCountForActionType to reset the counters.
MacTextEditor.hCopies a range of data.
OSStatus TXNGetData ( TXNObject iTXNObject, TXNOffset iStartOffset, TXNOffset iEndOffset, Handle *oDataHandle );
The text object that contains the data you want to copy.
The absolute offset from which data copying should begin. Make sure the iStartOffset and iEndOffset parameters do not specify a range that includes text and nontext data (that is, crosses a data type boundary). You can use the TXNGetSelection function to get the absolute offsets of the current selection.
The absolute offset at which data copying should end. You can use the TXNGetSelection function to get the absolute offsets of the current selection.
A pointer to a handle. On return, the handle points to the requested data. TXNGetData allocates the handle as necessary. Your application must dispose of the handle.
A result code. See “MLTE Result Codes.” The iStartOffset and iEndOffset parameters can specify a range that crosses a style run boundary but not a range that crosses a data type boundary. If the range includes text and nontext data, the TXNGetData function returns the error code kTXNIllegalToCrossDataBoundariesErr.
You first need to use the TXNCountRunsInRange function to find the number of data runs in a given range. Then you can examine each run’s type and text attributes with the TXNGetIndexedRunInfoFromRange function. Finally, use the TXNGetData function to examine data for each run of interest to you. The function does not check to see that the copied data aligns on a word boundary; data is simply copied as specified by the offset values.
Offsets in MLTE are always character offsets.
MacTextEditor.hCopies the text in a specified range, and if necessary, translates the text to match your application’s preferred encoding.
OSStatus TXNGetDataEncoded ( TXNObject iTXNObject, TXNOffset iStartOffset, TXNOffset iEndOffset, Handle *oDataHandle, TXNDataType iEncoding );
The text object that contains the data you want to copy.
The absolute offset from which data copying should begin. You can use the TXNGetSelection function to get the absolute offsets of the current selection.
The absolute offset at which data copying should end. You can use the TXNGetSelection function to get the absolute offsets of the current selection.
A pointer to a handle. On return, a handle to the requested data. TXNGetDataEncoded allocates the handle as necessary. Your application must dispose of the handle. If there is no text in the range specified, the returned handle is NULL, and the function returns noErr.
The type of data to be encoded. See Supported Data Types for a full description of possible values. You should specify either the kTXNTextData or kTXNUnicodeTextData constant. If the iEncoding parameter specifies an encoding different from that used to store the text data internally, the Conversion Manager translates the data to the specified type (text or Unicode). If the iEncoding parameter is not recognized, the data is returned in the current encoding. On systems that do not use ATSUI version 1.1 or later, the current encoding is the Mac OS encoding. Otherwise, the current encoding is Unicode.
A result code. See “MLTE Result Codes.”
Offsets in MLTE are always character offsets.
MacTextEditor.hObtains the current event target for a TXNObject.
OSStatus TXNGetEventTarget ( TXNObject iTXNObject, HIObjectRef *oEventTarget );
The text object.
A pointer to an HIObjectRef that, on return, points to the current event target for the TXNObject specified by iTXNObject.
A result code. See “MLTE Result Codes.”
This function obtains the current event target for the TXNObject specified by iTXNObject. Use this function to obtain the target and then install your own handlers.
MacTextEditor.hObtains the values for the current view, destination, or text rectangle.
OSStatus TXNGetHIRect ( TXNObject iTXNObject, TXNRectKey iTXNRectKey, HIRect *oRectangle );
The text object for the current text area. You can either call the function TXNCreateObject to allocate a text object or you can call the function HITextViewGetTXNObject to obtain the text object associated with an HITextView.
A value that specifies the rectangle you want the function to obtain. See Rectangle Keys for a list of the constants you can supply.
On output, points to the HIRect data structure that contains the coordinates for the requested rectangle.
A result code. See “MLTE Result Codes.”
MacTextEditor.hGets information about a run in a range of data.
OSStatus TXNGetIndexedRunInfoFromRange ( TXNObject iTXNObject, ItemCount iIndex, TXNOffset iStartOffset, TXNOffset iEndOffset, TXNOffset *oRunStartOffset, TXNOffset *oRunEndOffset, TXNDataType *oRunDataType, ItemCount iTypeAttributeCount, TXNTypeAttributes *ioTypeAttributes );
The text object for the current text area.
The value that corresponds to the run for which you want to get information. You call the TXNCountRunsInRange function to get the number of runs in a range. The iIndex parameter is zero-based, so its possible values are from 0 to the number of runs in a range minus 1. Note that the index is relative to the first run in the range specified by the iStartOffset and iEndOffset parameters, not for the entire document.
The offset at which you want to start to obtain run information. This value must be the same value that you passed previously to the function TXNCountRunsInRange.
The offset at which you want run information to end. This value must be the same value that you passed previously to the function TXNCountRunsInRange.
On return, a pointer to a value that identifies the start of run relative to the beginning of the text, not the beginning of the range you specified in the iStartOffset parameter.
On return, a pointer to a value that identifies the end of the run relative to the beginning of the text, not the beginning of the range you specified in the iStartOffset parameter.
On return, a pointer to a value that identifies the type of data in the run. See Supported Data Types for a description of possible values.
The number of font attributes.
A pointer to a structure of type TXNTypeAttributes. On input, you specify the attribute (such as size) in the tag field and the attribute size in the size field. You can pass NULL for the data field only if the size of the returned value <= 4. Otherwise a pointer to an appropriately sized block of data must be placed in one of the other members of the ioTypeAttributes union, such as, dataPtr, atsuFeatures, atsuVariations. On return, the data field contains the attribute data. The data field is a union that serves either as a 32-bit integer or a 32-bit pointer, depending on the size field.
A result code. See “MLTE Result Codes.”
You should first call the TXNCountRunsInRange function to get the count. The TXNTypeAttributes structure must specify the text attribute in which the application is interested. In other words, the tag and size fields must be set.
Offsets in MLTE are always character offsets.
If a tag specified in the ioTypeAttributes parameter is not recognized by MLTE—that is, the tag isn’t a TXTNTag value, a TXNTypeRunAttributes value, or a valid style run attribute tag (ATSUAttributeTag)—then the constant kTXNAttributeTagInvalidForRunErr is returned in the ioTypeAttributes->data.dataValue field for that particular tag. The function continues to process the remaining tags, but returns the result code kTXNSomeOrAllTagsInvalidForRunErr. Both of these values (kTXNAttributeTagInvalidForRunErr and kTXNSomeOrAllTagsInvalidForRunErr) are used either when a tag is not recognized or a tag is recognized but some error occurred in trying to obtain the attribute.
MacTextEditor.hGets the total number of lines in a text object.
OSStatus TXNGetLineCount ( TXNObject iTXNObject, ItemCount *oLineTotal );
The text object that identifies the document whose line count you want to get.
On return, a pointer to the number of lines in the text object.
A result code. See “MLTE Result Codes.”
MacTextEditor.hGets information about line width and height for a specified line of data in a text object.
OSStatus TXNGetLineMetrics ( TXNObject iTXNObject, unsigned long iLineNumber, Fixed *oLineWidth, Fixed *oLineHeight );
The text object that identifies the document whose line metrics you want to get.
A value that specifies the line whose metrics you want to retrieve. You should use the TXNGetLineCount function to determine how many lines are in the text object so that you specify a valid line number. Line numbers start at 0.
On return, a pointer to the width of the line, in pixels.
On return, a pointer to the height of the line, in pixels.
A result code. See “MLTE Result Codes.”
You can use height and width information to adjust the size of the text object’s frame.
MacTextEditor.hGets the absolute offsets of the current selection.
void TXNGetSelection ( TXNObject iTXNObject, TXNOffset *oStartOffset, TXNOffset *oEndOffset );
The text object for the current text area.
On return, a pointer to the absolute starting offset of the current selection.
On return, a pointer to the absolute ending offset of current selection.
Offsets in MLTE are always character offsets. Each embedded graphics or sound object is counted as one character.
MacTextEditor.hReports the appropriate amount of time to allot to background processes, depending on the state of the window.
UInt32 TXNGetSleepTicks ( TXNObject iTXNObject );
The text object that identifies the current document.
The appropriate wait time, in ticks. You pass this value to the WaitNextEvent function.
In a cooperative processing environment, your application must determine how much time to give to background processes. A tick is 1/60 of a second.
MacTextEditor.hDetermines whether the “Spell Check as You Type” feature is enabled.
Boolean TXNGetSpellCheckAsYouType ( TXNObject iTXNObject );
The text object to query.
A Boolean whose value is true if the “Spell Check as You Type” feature is enabled; otherwise, false.
Call TXNSetSpellCheckAsYouType to enable or disable the “Spell Check as You Type” feature.
MacTextEditor.hGets the current formatting and privileges attributes (such as justification, line direction, tab values, and read-only status) for a text object.
OSStatus TXNGetTXNObjectControls ( TXNObject iTXNObject, ItemCount iControlCount, const TXNControlTag iControlTags[], TXNControlData oControlData[] );
The text object that identifies the document to be activated.
The number of items in the iControlTags array.
An array of values that specify the kind of formatting information you want returned in the oControlData array. See Formatting and Privileges Settings for a description of possible values.
An array of TXNControlData unions. On return, the array contains the information that was requested through the iControlTags array. Your application must allocate the oControlData array.
A result code. See “MLTE Result Codes.”
MacTextEditor.hGets the rectangle that describes the current view of the document.
void TXNGetViewRect ( TXNObject iTXNObject, Rect *oViewRect );
The text object for the current text area.
On return, a pointer to a rectangle that describes the view of the document. The area described by the oViewRect parameter does not include the area that encloses the scroll bars. The coordinates of this rectangle are local to the window.
MacTextEditor.hReturns a reference to the window to which the specified text object is attached.
WindowRef TXNGetWindowRef ( TXNObject iTXNObject );
The text object for which you want to obtain a window reference. You can call the function TXNCreateObject to allocate a text object.
The window to which the text object is attached. Returns NULL if no window is attached.
MacTextEditor.hAdjusts the size of a window in response to mouse-down events in the size region of the window.
void TXNGrowWindow ( TXNObject iTXNObject, const EventRecord *iEvent );
The text object for the current text area.
A pointer to the event record that contains the mouse-down event you want to apply to the window.
The text object must be contained in a window and not a subframe of the window; otherwise the function does not adjust the size of the window. Before you call TXNGrowWindow, you should make sure that the front window belongs to your application.
MacTextEditor.hGets the offset value that corresponds to a point in local coordinates.
OSStatus TXNHIPointToOffset ( TXNObject iTXNObject, const HIPoint *iHIPoint, TXNOffset *oOffset );
The text object for which you want to obtain an offset value. You can either call the function TXNCreateObject to allocate a text object or you can call the function HITextViewGetTXNObject to obtain the text object associated with an HITextView.
The local coordinates of the point for which you want to obtain the offset value.
On output, a pointer to the offset that corresponds to the value of the iHIPoint parameter.
A result code. See “MLTE Result Codes.”
Offsets in MLTE are always character offsets.
MacTextEditor.hDoes idle time processing, such as flashing the cursor.
void TXNIdle ( TXNObject iTXNObject );
The text object that identifies the current document.
Before you call the TXNIdle function, you should make sure that the front window belongs to your application.
MacTextEditor.hInitializes MLTE.
OSStatus TXNInitTextension ( const TXNMacOSPreferredFontDescription iDefaultFonts[], ItemCount iCountDefaultFonts, TXNInitOptions iUsageFlags );
An array of TXNMacOSPreferredFontDescription structures. You use this to specify a table of font information that includes the font family ID, point size, style, and script code. The table can be NULL or can have an entry for any script for which you would like to designate a default font. To designate that MLTE should use the default settings for a specified script, you need to supply a valid script code value in the TextEncoding field of the font description structure and a value of kTXNUseScriptDefaultValue in all other fields of the structure. In Mac OS X, the default settings are read from the Theme settings. In Mac OS 9, the default settings are read from the Script Manager.
The number of scripts for which you are designating a default font in the iDefaultFonts array.
A value that specifies whether embedded objects should be supported. You can also specify whether MLTE should use QuickDraw as the imaging system and whether temporary memory should be used. See Initialization Option Masks for a description of possible values.
A result code. See “MLTE Result Codes.”
For systems prior to Mac OS X v10.3, you should call this function along with any other initialization calls you make when your application starts up. If you call this function a second time, it has no effect; the defaults you set up the first time you called the TXNInitTextension function are in effect until you call the TXNTerminateTextension function.
For Mac OS X v10.3 and later, you do not have to call this function. However, you may want to call this function to set default fonts that are different from the system default font or to enable multimedia support.
MacTextEditor.hTests whether the Clipboard contains data that is supported by MLTE.
Boolean TXNIsScrapPastable ( void );
Returns true if the data type on the Clipboard is supported.
You can call the TXNIsScrapPastable function to determine if the Paste item in the Edit menu should be active.
MacTextEditor.hDetermines whether the current selection is empty.
Boolean TXNIsSelectionEmpty ( TXNObject iTXNObject );
The text object for the current text area.
A Boolean value. It is true if the current selection is empty.
You can use the TXNIsSelectionEmpty function to determine whether your application should enable the Cut, Copy, and Clear items in the Edit menu.
MacTextEditor.hProcesses a key-down event.
void TXNKeyDown ( TXNObject iTXNObject, const EventRecord *iEvent );
The text object that identifies the active document.
A pointer to the event record that contains the key-down event you want handled. You cannot pass NULL.
Before you call the TXNKeyDown function, you should make sure that the front window belongs to your application. Text input occurs in the text object’s window. This is always the case unless the application has requested text input through a bottom-line window (a small window that appears at the bottom of the screen) or has turned off the Text Services Manager (TSM).
MacTextEditor.hObtains the local coordinates of the point that corresponds to a specified offset of a text object.
OSStatus TXNOffsetToHIPoint ( TXNObject iTXNObject, TXNOffset iOffset, HIPoint *oHIPoint );
The text object for which you want to obtain the local coordinates of a point. You can either call the function TXNCreateObject to allocate a text object or you can call the function HITextViewGetTXNObject to obtain the text object associated with an HITextView.
The offset value of the point for which you want to obtain the local coordinates.
On output, a pointer to the local coordinates of the point that corresponds to the value of the iOffset parameter.
A result code. See “MLTE Result Codes.”
Offsets in MLTE are always character offsets.
MacTextEditor.hDisplays the Page Setup dialog for the current default printer and manages changes, such as reformatting the text, in response to page layout changes.
OSStatus TXNPageSetup ( TXNObject iTXNObject );
The text object for the active document.
A result code. See “MLTE Result Codes.”
MacTextEditor.hPastes the contents of the private MLTE scrap into the text object.
OSStatus TXNPaste ( TXNObject iTXNObject );
The text object that identifies the current document.
A result code. See “MLTE Result Codes.”
Before you call TXNPaste, you can call the TXNIsScrapPastable function to determine if the current scrap contains data supported by MLTE.
MacTextEditor.hPrints the document so it is formatted to fit the page size selected for the printer.
OSStatus TXNPrint ( TXNObject iTXNObject );
The text object that identifies the document you want to print.
A result code. See “MLTE Result Codes.”
MacTextEditor.hReads data from a CFURLRef into a TXNObject.
OSStatus TXNReadFromCFURL ( TXNObject iTXNObject, TXNOffset iStartOffset, TXNOffset iEndOffset, CFDictionaryRef iDataOptions, CFURLRef iFileURL, CFDictionaryRef *oDocumentAttributes );
The text object into which data read from iFileURL is to be added.
The offset in iTXNObject at which to start placing data read from iFileURL.
The offset in iTXNObject at which to stop placing data read from iFileURL.
Options for reading the data. See Data Option Key Value Constants for a list of the supported options. If this parameter is NULL, the data is read in using MLTE’s native format.
A CFURLRef to the data that is to be added to the text object specified by inTXNObject.
A value of type CFDictionary that, on return, contains the document attributes present in the data stream, if the file format supports them; otherwise this parameter is NULL. The native MLTE file format and RTF support embedded document attributes. See Document Attribute Keys for a list of supported attributes. If this parameter is NULL, no document attributes are written out.
A result code. See “MLTE Result Codes.”
This function reads data from a file or a special file bundle (directory) into a text object. Offset parameters are used to specify whether the new data is inserted, appended or replaces an existing data range in the text object. Clients can specify the document format and encoding of the data using the iDataOptions parameter. This functions also returns the document attributes present in the data stream. Document attributes are supported only for the rich text file formats supported by MLTE, which are RTF and MLTE native file format.
If the caller passes a pointer to a CFDictionaryRef, this function returns a reference to a dictionary of attributes, if there is one, that the caller is responsible for releasing. In all other cases, this function sets the reference to NULL. Here is some sample code:
CFDictionaryRef oDocumentAttributes = NULL; |
status = TXNReadFromCFURL (....,&oDocumentAttributes); |
if (oDocumentAttributes != NULL) ::CFRelease(oDocumentAttributes); |
MacTextEditor.hRecalculates the text layout based on new view and destination rectangles.
void TXNRecalcTextLayout ( TXNObject iTXNObject );
The text object whose layout you want to recalculate.
You can call the function TXNRecalcTextLayout if you call the function TXNSetRectBounds with the iUpdate parameter set to false. TXNRecalcTextLayout recalculates the text layout as well as where the scroll bars, if any, should be placed. When you call TXNRecalcTextLayout, MLTE generates an update event to redraw the text object.
MacTextEditor.hRedoes the last command.
void TXNRedo ( TXNObject iTXNObject );
The text object for the document you want to examine.
If the user undoes an action and then undoes it again, the second undo is the same as a redo.
MacTextEditor.hInstalls or uninstalls a scrolling callback function on a text object.
void TXNRegisterScrollInfoProc ( TXNObject iTXNObject, TXNScrollInfoUPP iTXNScrollInfoUPP, SRefCon iRefCon );
The text object on which you want to install a callback to scroll text.
A universal procedure pointer to the callback function you want MLTE to call whenever a scroll bar for the text object must be updated.
A 32-bit value that is passed to your callback.
You can call the function TXNRegisterScrollInfoProc to install a text-scrolling callback on a text object. This is useful if your application draws and handles its own scrolling widgets. Once you register your callback (TXNScrollInfoUPP), MLTE invokes your callback each time it is necessary to update the values and maximum values of your scrolling widget. For example when the user presses the Return key to add a new line, MLTE calculates a new maximum value for the text object. Your callback is then called with the newly-calculated maximum value. To turn off your callback call the function TXNRegisterScrollInfoProc with a value of NULL for the iTXNScrollInfoUPP parameter.
MacTextEditor.hResizes the view and destination rectangles.
void TXNResizeFrame ( TXNObject iTXNObject, UInt32 iWidth, UInt32 iHeight, TXNFrameID iTXNFrameID );
The text object for the current text area.
The new width of the view and destination rectangles in pixels.
The new height of the view and destination rectangles in pixels.
The frame ID of the frame associated with the view and destination rectangles you want to resize. You obtain the frame ID when you call the TXNNewObject function.
You need to call the function TXNSetFrameBounds if you want to reset the frame bounds.
MacTextEditor.hReverts to the last saved version of a document.
OSStatus TXNRevert ( TXNObject iTXNObject );
The text object for the active document.
A result code. See “MLTE Result Codes.”
You can use the TXNRevert function with files that contain only text as well as files that were created using MLTE. If the file was not previously saved, the document reverts to an empty document. To revert to data that is embedded in a private file type, use the TXNSetSelection function to select all of the current data and then use the TXNSetDataFromFile function to read in the old data.
MacTextEditor.hScrolls the text within a view rectangle of the specified text object.
OSStatus TXNScroll ( TXNObject iTXNObject, TXNScrollUnit iVerticalScrollUnit, TXNScrollUnit iHorizontalScrollUnit, long *ioVerticalDelta, long *ioHorizontalDelta );
The text object whose text you want to scroll.
Specifies the units to use for the ioVerticalDelta parameter. Pass kTXNScrollUnitsInPixels to specify pixels, pass kTXNScrollUnitsInLines to specify a count of lines, and pass kTXNScrollUnitsInViewRects to specify the height of the current view rectangle (viewRect). Note that scrolling in line units is the slowest because each line must be measured by MLTE before the text scrolls. See Scroll Units for more information.
Specifies the units to use for the ioHorizontalDelta parameter. Pass kTXNScrollUnitsInPixels to specify pixels, pass kTXNScrollUnitsInLines to specify a count of lines, and pass kTXNScrollUnitsInViewRects to specify the height of the current view rectangle (viewRect). Note that scrolling in line units is the slowest because each line must be measured by MLTE before the text scrolls. See Scroll Units for more information.
On input, the number of units by which to scroll in the vertical direction. You specify the units in the iVerticalScollUnit parameter. On output, the number of units actually scrolled in the vertical direction. A positive value indicates to move the text in a downward direction.
On input, the number of units by which to scroll in the horizontal direction. You specify the units in the iHorizontalScrollUnit parameter. On output, the number of units actually scrolled in the horizontal direction. A positive value indicates to move the text to the right.
A result code. See “MLTE Result Codes.”
The function TXNScroll moves the text within the view rectangle of the specified text object by the designated number of units. You can use this function to scroll the text in a text object in response to user input in a control other than the standard scroll bars that MLTE supplies.
MacTextEditor.hSelects all data in the frame of a text object.
void TXNSelectAll ( TXNObject iTXNObject );
The text object for the current text area.
You can check whether your application should enable the Select All menu item by calling the TXNDataSize function to check if the text object contains any data.
MacTextEditor.hSets a callback that MLTE uses to obtain the localized string representing an action or an action group.
OSStatus TXNSetActionNameMapper ( TXNObject iTXNObject, TXNActionNameMapperUPP iStringForKeyProc, const void *iUserData );
The text object for which the callback is to be set.
The callback.
A pointer to user-defined data that will help you map the action key to a string.
A result code. See “MLTE Result Codes.”
If you have asked MLTE to handle updating for the Redo and Undo commands in the Edit menu, you should call this function so that MLTE can call your callback, which provides the correct string for each of those commands.
When MLTE’s handler for kEventClassCommand/kEventCommandUpdateStatus is called for the Redo or Undo command, MLTE checks to see if a TXNActionNameMapperProc has been installed. If a TXNActionNameMapperProc is installed, it is called to get the correct string for updating the menu item. The client can used the action name and the command ID to determine the appropriate string.
For information on a TXNActionNameMapperProc, see TXNActionNameMapperProcPtr.
MacTextEditor.hSets the background on which the text object’s data is drawn.
OSStatus TXNSetBackground ( TXNObject iTXNObject, const TXNBackground *iBackgroundInfo );
The text object that identifies the document to be activated.
A pointer to a structure that describes the background.
A result code. See “MLTE Result Codes.”
MLTE supports only color as the background.
MacTextEditor.hEnables and disables support for menu commands in MLTE.
OSStatus TXNSetCommandEventSupport ( TXNObject iTXNObject, TXNCommandEventSupportOptions iOptions );
The TXNObject.
The menu commands for which support is to be enabled or disabled. For possible values, see Command Event Support Options.
A result code. See “MLTE Result Codes.”
When TXNAttachObjectToWindow or TXNSetEventTarget is called to associate an MLTE object with an HIObject that can serve as an event target, most handlers are installed and activated immediately.
However, when the handlers for the kEventClassCommand class are installed, they are not activated. Call this function to activate the handlers for this class, which provide support for the menu commands. This approach means that an application can install handlers on top of these and be sure that enabling or disabling the MLTE handlers does not change the order of the handler chain.
MacTextEditor.hProvides a callback function that is called before MLTE displays its contextual menu.
OSStatus TXNSetContextualMenuSetup ( TXNObject iTXNObject, TXNContextualMenuSetupUPP iMenuSetupProc, const void *iUserData );
The text object.
The callback. For more information, see NewTXNContextualMenuSetupUPP.
A pointer to user-defined data that will be passed to the callback specified by the iMenuSetupProc parameter.
A result code. See “MLTE Result Codes.”
The callback function specified by iMenuSetupProc is called just before MLTE displays its contextual menu. The menu that is passed to the callback contains MLTE-specific items only. The client items and handlers should be installed each time the callback is called.
When the callback is called, MLTE has selected the word the user clicked with the Option key pressed. For convenience, the TXNObject associated with the callback is passed to the callback as well as the data specified by iUserData.
MacTextEditor.hReplaces a range of data (text, graphics, and so forth).
OSStatus TXNSetData ( TXNObject iTXNObject, TXNDataType iDataType, const void *iDataPtr, ByteCount iDataSize, TXNOffset iStartOffset, TXNOffset iEndOffset );
The text object that identifies the document in which you want to replace data.
The type of the replacement data. See Supported Data Types for a description of possible values.
A pointer to the data that will replace the data that is in the range specified by the iStartOffset and iEndOffset parameters.
The size of the data (in bytes) to which iDataPtr points.
The beginning of the range of data to replace. You can use the TXNGetSelection function to get the absolute offsets of the current selection.
The end of the range to replace. You can use the TXNGetSelection function to get the absolute offsets of the current selection. If you want to insert text, the ending and starting offsets should be the same value.
A result code. See “MLTE Result Codes.”
If you have a text object that has word wrap disabled, and you want to avoid horizontal scrolling, you can try the following. After you call the function TXNSetData, call TXNSetSelection with the value of the ending offset set to what it was before you called TXNSetData. Then, call the function TXNShowSelection to scroll the text back into view.
Offsets in MLTE are always character offsets.
MacTextEditor.hSets a Carbon Event target for MLTE Carbon Event handlers.
OSStatus TXNSetEventTarget ( TXNObject iTXNObject, HIObjectRef iEventTarget );
The TXNObject.
The HIObjectRef that is to be set as the event target for all of the Carbon Event handlers of the TXNObject specified by iTXNObject.
A result code. See “MLTE Result Codes.”
The default target for a TXNObject that is not contained in an HITextView is the window of the TXNObject. Call this function when you want to override or set the Carbon Event target for a TXNObject.
Note that if the TXNObject already has a default target when this function is called, the handlers are removed from the old target before the new handlers are installed.
When this function returns, these handlers for Carbon Events are installed and active for the kEventClassTextInput class:
kEventTextInputUpdateActiveInputArea
kEventTextInputUnicodeForKeyEvent
kEventTextInputUnicodeText
kEventTextInputOffsetToPos
kEventTextInputPosToOffset
kEventTextInputGetSelectedText
When this function returns, these handlers for Carbon Events are installed and active for the kEventClassTSMDocumentAccess class:
kEventTSMDocumentAccessGetLength
kEventTSMDocumentAccessGetSelectedRange
kEventTSMDocumentAccessGetCharactersPtr
kEventTSMDocumentAccessGetCharactersPtrForLargestBuffer
kEventTSMDocumentAccessGetCharacters
kEventTSMDocumentAccessGetFont
kEventTSMDocumentAccessGetGlyphInfo
When this function returns, these handlers for Carbon Events are installed and active for the kEventClassFont class:
kEventFontPanelClosed
kEventFontSelection
When this function returns, these handlers for Carbon Events are installed and inactive by default for the kEventClassCommand class:
kEventProcessCommand
kEventCommandUpdateStatus
The kEventClassCommand handlers support the following commands:
kHICommandUndo
kHICommandRedo
kHICommandSelectAll
kHICommandCut
kHICommandCopy
kHICommandPaste
kHICommandClear
kHICommandShowSpellingPanel
kHICommandCheckSpelling
kHICommandChangeSpelling
kHICommandCheckSpellingAsYouType
kHICommandIgnoreSpelling
kHICommandLearnWord
Activate command support by calling TXNSetCommandEventSupport with the appropriate options.
MacTextEditor.hChanges the boundaries of a text object’s frame.
void TXNSetFrameBounds ( TXNObject iTXNObject, SInt32 iTop, SInt32 iLeft, SInt32 iBottom, SInt32 iRight, TXNFrameID iTXNFrameID );
The text object for the current text area.
The top boundary of the rectangle.
The left boundary of the rectangle.
The bottom boundary of the rectangle.
The right boundary of the rectangle.
The frame ID of the frame you want to move. You obtain a frame ID when you call the TXNNewObject function.
If you want to change the view and destination rectangles, you should call the TXNResizeFrame function.
MacTextEditor.hSets the view rectangle and/or the destination rectangle.
void TXNSetHIRectBounds ( TXNObject iTXNObject, const HIRect *iViewRect, const HIRect *iDestinationRect, Boolean iUpdate );
The text object for the current text area. You can call the function TXNCreateObject to allocate a text object.
A pointer to rectangle that contains the new coordinates for the view rectangle. If you do not want to change the view rectangle pass NULL. You cannot set the view rectangle for text objects into an HITextView, you can only set the destination rectangle.
A pointer to a rectangle that contains the new coordinates for the destination rectangle. If you do not want to change the destination rectangle pass NULL.
A value that specifies whether you want the text and scroll bars recalculated and redrawn. Pass true to recalculate and redraw; otherwise pass false. You must pass false for text objects into an HITextView.
The view rectangle controls the text you see. The destination rectangle controls how text is laid out. You can specify coordinates for one or both rectangles. Scroll bars are drawn inside the view rectangle.
MacTextEditor.hSets the state of the scroll bars so they are drawn correctly in response to activate events.
OSStatus TXNSetScrollbarState ( TXNObject iTXNObject, TXNScrollBarState iActiveState );
The text object that identifies the document you want activated. You can call the function TXNCreateObject to allocate a text object.
A value that indicates the state of the scroll bars. See Scroll Bar States for a description of possible values. If you pass the kScrollBarsAlwaysActive constant, the scroll bars are always active, whether or not the frame text area currently has keyboard focus. Passing kScrollBarsAlwaysActive can be useful for a window such as a dialog that may contain multiple text areas, each of which may have a scrollable frame. If you pass kScrollBarsSyncWithFocus, MLTE synchronizes the activity state of the scroll bars with the focus state of the frame. Therefore, only when the frame has keyboard focus does it have active scroll bars. A value of kScrollBarsSyncWithFocus is the default and is typically recommended if you have only one frame per window.
A result code. See “MLTE Result Codes.” This function returns an error if the text object is in an HITextView.
This function is a macro that calls the function TXNActivate with the TXNFrameID parameter set to 0. You typically call TXNSetScrollbarState in response to an activate event. If the text object was previously inactive, TXNSetScrollbarState removes any visual indication of its prior inactive state (such as a dimmed or framed selection area or inactive scroll bars). Before you call the TXNSetScrollbarState function, you should make sure that the window belongs to your application.
The TXNSetScrollbarState function does not change the keyboard focus. This means your application can have a text area that is not focused, but in which the scroll bars are active. This lets application users scroll the inactive text without changing the focus from another text area.
If you want to display a text area that has both keyboard focus and active scroll bars, you must call the TXNFocus function immediately before you call the TXNSetScrollbarState function. Note that MLTE does not retain information about keyboard focus. So if, for example, you set the keyboard focus on a text area and the window containing the text area becomes deactivated, you must call the TXNFocus function when the window becomes activated again.
MacTextEditor.hSpecifies the selection range or the position of the insertion point.
OSStatus TXNSetSelection ( TXNObject iTXNObject, TXNOffset iStartOffset, TXNOffset iEndOffset );
The text object that identifies the document for which you want to set the selection range or insertion point position.
The new starting offset. Offset values are character offsets.
The new ending offset. Offset values are character offsets.
A result code. See “MLTE Result Codes.”
You can use the TXNSetSelection function to highlight an initial default value in a document, such as a data-entry form, or to position the insertion point at the start of the field where you want the user to enter a value. To position the insertion point, specify the same value for the iStartOffset and iEndOffset parameters.
MacTextEditor.hEnables and disables the “Spell Check as You Type” feature.
OSStatus TXNSetSpellCheckAsYouType ( TXNObject iTXNObject, Boolean iActivate );
The text object for which the “Spell Check as You Type” feature is to be enabled or disabled.
A Boolean whose value is true to enable the “Spell Check as You Type” feature or false to disable it.
A result code. See “MLTE Result Codes.” If TXNSetCommandEventSupport has not been called to enable the event handler for spell checking, an error is returned.
MacTextEditor.hSets formatting and privileges attributes (such as justification, line direction, tab values, and read-only status) that apply to the entire text object.
OSStatus TXNSetTXNObjectControls ( TXNObject iTXNObject, Boolean iClearAll, ItemCount iControlCount, const TXNControlTag iControlTags[], const TXNControlData iControlData[] );
The text object that identifies the document for which you want to set formatting and privileges attributes.
A Boolean value. If you set this to true, all formatting and privileges attributes are reset to their default value. That is, true clears existing tags and resets each to its default value.
The number of items in the iControlTags array.
An array of values that specifies kind of data that is passed in the iControlData parameter. See Formatting and Privileges Settings for a description of possible values. On systems that use Apple Type Services for Unicode Imaging (ATSUI), you can also pass any of the following ATSUI attribute tag constants:
kATSULineDirectionTag
kATSULineJustificationFactorTag
kATSULineFlushFactorTag
kATSULineBaselineValuesTag
kATSULineLayoutOptionsTag
kATSUCGContextTag
See the ATSUI documentation for a description of these ATSUI constants.
An array of TXNControlData unions that contain the information your application wants to set. The value you supply to the iControlTags parameter specifies how the union of type TXNControlData is treated. You must make sure that the value you assign to the iControlData parameter is the appropriate type implied by the value you passed in the iControlTags parameter.
A result code. See “MLTE Result Codes.”
On systems that use Apple Type Services for Unicode Imaging (ATSUI), the ATSUI line control attribute tags can be passed to this function in the iControlTag parameter. This is the case for all the ATSUI tags except kATSULineRotationTag. ATSUI tags are applied to the entire text object.
MacTextEditor.hSets text attributes (such as size and style) for the current selection or the text defined by a range you specify.
OSStatus TXNSetTypeAttributes ( TXNObject iTXNObject, ItemCount iAttrCount, const TXNTypeAttributes iAttributes[], TXNOffset iStartOffset, TXNOffset iEndOffset );
The text object that contains the current selection.
The number of font attributes in the iAttributes array.
An array of TXNTypeAttributes structures in which you specify the attributes you want to set. Values passed in the iAttributes array that are less than or equal to sizeof(UInt32) are passed by value. Values greater than sizeof(UInt32) are passed as a pointer. That is, the third field of the TXNTypeAttributes structure is a union that serves as either a 32-bit integer or a 32-bit pointer.
The starting offset at which you want the application to begin setting attributes. If you want to use the current selection, set iStartOffset to kTXNUseCurrentSelection.
The offset at which you want the application to stop setting attributes. If you want to use the current selection, set iEndOffset to kTXNUseCurrentSelection.
A result code. See “MLTE Result Codes.”
You can use this function to clear ATSUI font features and ATSUI font variations. To clear either the features or the variations, you must OR the kTXNClearTheseFontFeatures constant with the current ATSUI font feature or font variation setting. See Clearance Settings for more information.
Offsets in MLTE are always character offsets.
MacTextEditor.hScrolls the current selection into view.
void TXNShowSelection ( TXNObject iTXNObject, Boolean iShowEnd );
The text object for the current text area.
A Boolean value. If you set this to true, the end of the selection is scrolled into view. Otherwise, the beginning of the selection is scrolled into view.
You can use this to scroll text into view after you have called the TXNFind function and the matching text is not in the current view of the text object.
MacTextEditor.hChecks to see if the Text Services Manager (TSM) is active.
Not Supported
Boolean TXNTSMCheck ( TXNObject iTXNObject, EventRecord *iEvent );
The text object that identifies the current document. Pass NULL when there is no active text object and you want to check for TSM activity.
A pointer to an event record structure. This can be NULL.
A Boolean value. It is true if TSM is active and false if TSM is not active.
The purpose of this function is to ensure input methods have enough time to respond. Call this when the WaitNextEvent function returns false or there is no active text object. For a Unicode application, if the event is a key-down event, TXNTSMCheck will also process the event and set the event to NULL.
MacTextEditor.hUndoes the last command.
void TXNUndo ( TXNObject iTXNObject );
The text object for the document you want to examine.
The undo stack is 32 levels deep. That is, undoable actions are tracked until the total count is 32. If a user undoes two actions, the Redo command must be used twice to get back to the original state. If more than 32 actions are performed, the oldest actions are forgotten as each new action takes place.
If the user performs a new action after choosing Redo from the Edit menu, the redone action is no longer available to be undone. For example, a user performs the following actions: types some text, cuts some text, pastes some text, types some text; undoes the last typing action, and undoes the paste operation; redoes the paste; types some new text. After the new text has been typed, the undo stack contains the first text that was typed, the cut action, and the new text that was just typed.
MacTextEditor.hRedraws everything in a frame in response to an update event.
void TXNUpdate ( TXNObject iTXNObject );
The text object that identifies the document to be updated.
This function calls the Window Manager BeginUpdate and EndUpdate functions for the window that you pass to the TXNNewObject function. You shouldn’t use it for windows that contain something else besides the text object. If the window contains something in addition to the text object, you should use the TXNDraw function instead of the TXNUpdate function.
Before you call TXNUpdate, you should make sure that the window belongs to your application. The TXNUpdate function redraws any content that needs updating regardless of the layer in which your window is located.
MacTextEditor.hGets the version number of MLTE and the set of features in this version.
TXNVersionValue TXNVersionInformation ( TXNFeatureBits *oFeatureFlags );
On return, a pointer to a value that indicates the set of features in use in this version. See Frame Option Bits and ATSUI Feature Masks for a description of possible values.
A value that specifies the version of MLTE. See the description of the TXNVersionValue data type.
If the bit kTXNWillDefaultToATSUIBit is set, then by default MLTE uses ATSUI to image and measure text and uses Unicode to store characters. If the bit kTXNWillDefaultToCarbonEventBit is set, then, by default, MLTE uses Carbon events and Apple events are not supported.
MacTextEditor.hWrites a range of a text object to a file or to a special file bundle.
OSStatus TXNWriteRangeToCFURL ( TXNObject iTXNObject, TXNOffset iStartOffset, TXNOffset iEndOffset, CFDictionaryRef iDataOptions, CFDictionaryRef iDocumentAttributes, CFURLRef iFileURL );
The text object having a range that is to be written.
The offset in iTXNObject at which to start writing data to iFileURL.
The offset in iTXNObject at which to stop writing data to iFileURL.
A CFDictionaryRef that specifies options for writing out the data. See Data Option Key Value Constants for a list of the supported options. If this parameter is NULL, the data is written out using MLTE’s native format.
The document attributes that are to be embedded in the data stream. This parameter is only supported when writing out the data using one of the following formats: RTF and MLTE native format. Only the key / values defined in Document Attribute Keys are written out. The content of the dictionary is ignored for any other format. If the dictionary is NULL, no attributes are added to the data stream.
CFURLRef for an existing file or directory, whichever is appropriate for the file type. On return, iFileURL contains a copy of the data in the given range for the iTXNObject with the format and encoding specified by iDataOptions.
A result code. See “MLTE Result Codes.”
This function writes a range of a text object to a file or a special file bundle (directory). It supports several document formats and encodings, which can be specified in the data options dictionary. Clients can specify additional document attributes when data is written out using a file format, such as RTF and native MLTE file format) that supports such attributes.
MacTextEditor.hIncreases the size of the data displayed in a window in response to a click in the zoom box.
void TXNZoomWindow ( TXNObject iTXNObject, SInt16 iPart );
The text object for the current text area.
The location, in global coordinates, of the cursor at the time the user pressed the mouse button. You obtain this value from the Window Manager function FindWindow.
Before you call the TXNZoomWindow function, you should make sure that the window belongs to your application. You should use the TXNZoomWindow function only when a text object has a viewable area that occupies the entire window; for example, if you passed NULL for the iFrame parameter when you called the TXNNewObject function to create the text object. You cannot use TXNZoomWindow if the text object is contained in a subframe of a window.
MacTextEditor.hDefines a pointer to an action key mapping function that customizes the Redo and Undo menu items with the specific action that can be redone or undone. (Deprecated. Use TXNActionNameMapperProcPtr instead.)
typedef CFStringRef(* TXNActionKeyMapperProcPtr) ( TXNActionKey actionKey, UInt32 commandID );
You would declare your function like this if you were to name it MyTXNActionKeyMapperFunction:
CFStringRef MyTXNActionKeyMapperCallback ( TXNActionKey actionKey, UInt32 commandID );
A value of type TXNActionKey that indicates an editing action taken by the user.
The command ID of menu command chosen by the user.
The localized string you want to map to the TXNActionKey.
Your callback is invoked each time you ask MLTE to handle command updates for the Edit menu. MLTE calls your callback whenever it receives a Carbon event of class kEventClassCommand and event kind kEventComandUpdateStatus for the command ID kHICommandUndo. In other words, whenever the undo-command item in the menu needs to be updated. Your callback should examine the actionKey parameter and return an appropriately localized CFStringRef that describes the undo action. MLTE calls the function SetMenuItemWithCFString to update the menu item’s text. You are responsible for releasing the CFString; MLTE does not call the function CFRelease on the string.
You provide a pointer to your action key mapping callback function when you build a dictionary to support Carbon events in MLTE. The pointer should be the value associated with the dictionary key kTXNActionKeyMapperKey. You then assign the dictionary to a TXNCarbonEventInfo data structure. You treat the data structure as an object control. That is, you associate the TXNCarbonEventInfo data structure with a text object by calling the function TXNSetTXNObjectControls, supplying kTXNUseCarbonEvents in the iControlsTags parameter and the TXNCarbonEventInfo data structure in the iControlData parameter.
To provide a pointer to your action key mapping callback function, you use the NewTXNActionKeyMapperUPP function to create a universal procedure pointer (UPP) of type TXNActionKeyMapperUPP. You can do so with code similar to the following:
TXNActionKeyMapperUPP MyTXNActionKeyMapperUPP; |
MyTXNActionKeyMapperUPP = NewTXNActionKeyMapperUPP |
(&MyActionKeyMapperFunction); |
When you are finished with your action key mapper callback function, you should use the DisposeTXNActionKeyMapperUPP function to dispose of the UPP associated with it. However, if you plan to use the same action key mapper callback later in your application, you can reuse the same UPP, rather than dispose of it and later create a new UPP.
MacTextEditor.hDefines a pointer to an action name mapping function that customizes the Redo and Undo menu items with the specific action that can be redone or undone.
typedef CFStringRef TXNActionNameMapperProcPtr ( CFStringRef actionName, UInt32 commandID, void * inUserData );
If you name your function MyTXNActionNameMapperProc, you would declare it like this:
CFStringRef MyTXNActionNameMapperProc ( CFStringRef actionName, UInt32 commandID, void * inUserData );
The name of the action.
The command ID of the menu command.
User-defined data that was provided in the inUserData parameter when InvokeTXNActionNameMapperUPP was called.
MacTextEditor.hDefines a pointer to a contextual menu setup function.
typedef void TXNContextualMenuSetupProcPtr ( MenuRef iContextualMenu, TXNObject object, void * inUserData );
If you name your function MyTXNContextualMenuSetupProc, you would declare it like this:
void MyTXNContextualMenuSetupProc ( MenuRef iContextualMenu, TXNObject object, void * inUserData );
The MLTE contextual menu.
The TXNObject for which MyTXNContextualMenuSetupProc was called.
User-defined data that was passed to TXNSetContextualMenuSetup.
MacTextEditor.hDefines a pointer to a find function that customizes a search tailored to your application’s needs.
typedef OSStatus (*TXNFindProcPtr) ( const TXNMatchTextRecord * matchData, TXNDataType iDataType, TXNMatchOptions iMatchOptions, const void * iSearchTextPtr, TextEncoding encoding, TXNOffset absStartOffset, ByteCount searchTextLength, TXNOffset * oStartMatch, TXNOffset * oEndMatch, Boolean * ofound, UInt32 refCon );
If you name your function MyTXNFindProc, you would declare it like this:
OSStatus TXNFindProcPtr ( const TXNMatchTextRecord * matchData, TXNDataType iDataType, TXNMatchOptions iMatchOptions, const void * iSearchTextPtr, TextEncoding encoding, TXNOffset absStartOffset, ByteCount searchTextLength, TXNOffset * oStartMatch, TXNOffset * oEndMatch, Boolean * ofound, UInt32 refCon );
A pointer to a TXNMatchTextRecord structure containing the text to match, the length of that text, and the text’s encoding. Pass NULL if you are looking for a graphics, sound, or movie object.
The type of data for which you want to search. See Supported Data Types for a description of possible values.
A value that specifies the matching rules to use in the find operation. See Search Criteria Masks for a description of possible values.
A pointer to the text to search.
The encoding of the text to search.
The offset at which the search should begin. The constant kTXNStartOffset specifies the start of the object’s data.
The length, in bytes, of the text to search.
On return, a pointer to the absolute offset that identifies the start of the match. Your function should set this to kTXNUseCurrentSelection if there is no match.
On return, a pointer to the absolute offset that identifies the end of the match. Your function should set this to kTXNUseCurrentSelection if there is no match.
On return, a pointer to a Boolean value; true if a match is found.
An unsigned 32-bit integer your application can use as needed.
A result code. See “MLTE Result Codes.”
You pass a pointer to your find callback function as a parameter to the TXNFind function. To provide a pointer to your find callback function, you use the NewTXNFindUPP function to create a universal procedure pointer (UPP) of type TXNFindUPP. You can do so with code similar to the following:
TXNFindUPP MyTXNFindUPP; |
MyTXNFindUPP = NewTXNFindUPP (&MyFindCallback) |
When you are finished with your find callback function, you should use the DisposeTXNFindUPP function to dispose of the UPP associated with it. However, if you plan to use the same find callback function in subsequent calls to the TXNFind function, you can reuse the same UPP, rather than dispose of it and later create a new UPP.
MacTextEditor.hDefines a pointer to a customized scrolling function.
typedef void TXNScrollInfoProcPtr ( SInt32 iValue, SInt32 iMaximumValue, TXNScrollBarOrientation iScrollBarOrientation, SInt32 iRefCon );
If you name your function MyTXNScrollInfoProc, you would declare it like this:
void MyTXNScrollInfoProc ( SInt32 iValue, SInt32 iMaximumValue, TXNScrollBarOrientation iScrollBarOrientation, SInt32 iRefCon );
The scroll bar value.
The scroll bar maximum value.
The orientation of the scroll bar. See Scroll Bar Orientation for more information.
An unsigned 32-bit integer your application can use as needed. This is set and used by your application as needed.
You can create a callback to handle and draw your own scroll bar. MLTE calls your callback each time the scroll bar value and the maximum value of the scroll bar needs to be updated. You install a text-scrolling callback on an MLTE text object by calling the function TXNRegisterScrollInfoProc. When you no longer want the text-scrolling callback invoked on the text object, you can call the function TXNRegisterScrollInfoProc with the iTXNScrollInfoUPP set to NULL.
MacTextEditor.hDefines a universal procedure pointer to an action name mapper callback function.
typedef TXNScrollActionNameProcPtr TXNActionNameMapperUPP;
See TXNActionNameMapperProcPtr for more information.
MacTextEditor.hDefines a universal procedure pointer to an action key mapping callback function.
typedef TXNActionKeyMapperProcPtr TXNActionKeyMapperUPP;
See TXNActionKeyMapperProcPtr for more information.
MacTextEditor.hContains information about ATSUI font features.
struct TXNATSUIFeatures {
ItemCount featureCount;
ATSUFontFeatureType * featureTypes;
ATSUFontFeatureSelector * featureSelectors;
};
typedef struct TXNATSUIFeatures TXNATSUIFeatures;
featureCountThe number of features described in this structure.
featureTypesA pointer to a variable of type ATSUFontFeatureType. The ATSUFontFeatureType type represents the attributes of a particular font feature, such as the presence of ligatures in a font.
featureSelectorsA pointer to a variable of type ATSUFontFeatureSelector. The ATSUFontFeatureSelector type represents the state of a feature (on or off).
Used in the TXNAttributeData union.
MacTextEditor.hContains information about ATSUI variations.
struct TXNATSUIVariations {
ItemCount variationCount;
ATSUFontVariationAxis * variationAxis;
ATSUFontVariationValue * variationValues;
};
typedef struct TXNATSUIVariations TXNATSUIVariations;
variationCountThe number of variables described in this structure.
variationAxisA pointer to a variable of type ATSUFontVariationAxis. The ATSUFontVariationAxis type represents a stylistic attribute and the range of values used to express this attribute for a font.
variationValuesA pointer to a variable of type ATSUFontVariationValue. The ATSUFontVariationValue type represents the range of values that a font can use for a particular font variation.
Used in the TXNAttributeData union.
MacTextEditor.hContains information about text attributes in a text object.
union TXNAttributeData {
void * dataPtr;
UInt32 dataValue;
TXNATSUIFeatures *atsuFeatures;
TXNATSUIVariations *atsuVariations;
CFURLRef urlReference;
};
typedef union TXNAttributeData TXNAttributeData;
dataPtrA pointer to attribute data. For example, a pointer to a font name.
dataValueA value that specifies a text attribute. For example, a value that specifies a font style.
atsuFeaturesA pointer to a TXNATSUIFeatures structure. For example, a structure that contains information about the ligatures in a font.
atsuVariationsA pointer to a TXNATSUIVariations structure. For example, a structure that contains information about the range of values used to express a particular stylistic attribute.
urlReferenceA URL that specifies the location of attribute data.
Used in the TXNTypeAttributes structure. The data contained in the union is determined by the value in the size field of the TXNTypeAttributes structure.
MacTextEditor.hSpecifies the background for text and other data in a text object.
struct TXNBackground {
TXNBackgroundType bgType;
TXNBackgroundData bg;
};
typedef struct TXNBackground TXNBackground;
bgTypeDefines the type of data. See TXNBackgroundType data type.
bgSpecifies the data MLTE should use as a background.
Used in the TXNSetBackground function.
MLTE 1.1 and earlier supports only color.
MacTextEditor.hRepresents background data used in the TXNBackground structure.
union TXNBackgroundData {
RGBColor color;
};
typedef union TXNBackgroundData TXNBackgroundData;
colorA value that specifies the background color on which data is displayed. Color is the only background data that is currently supported.
MacTextEditor.hContains information needed for MLTE to support Carbon events.
struct TXNCarbonEventInfo {
Boolean useCarbonEvents;
UInt8 filler;
UInt16 flags;
CFDictionaryRef fDictionary;
};
typedef struct TXNCarbonEventInfo TXNCarbonEventInfo;
useCarbonEventsPass true to specify a Carbon event, otherwise Apple events will be used by the system to handle MLTE events.
fillerPadding you don’t need to pass anything.
flagsThere are currently two flags defined: kTXNNoAppleEventHandlersMask and kTXNRestartAppleEventHandlersMask. When you request Carbon event support for text input events, it’s best to specify the kTXNNoAppleEventHandlersMask mask.
fDictionaryA reference to a Core Foundation dictionary. (A dictionary is a collection of key-value pairs.) For MLTE to support Carbon events, you need to build a dictionary whose keys are strings that represent the events you want handled (such as “TextInput” or “WindowResize”) and whose values are event target references associated with the events. See “Dictionary Keys” for a list of the predefined keys you can use to build the dictionary.
You set up MLTE to support Carbon events by passing the TXNCarbonEventInfo structure when you call the function TXNSetTXNObjectControls. Note that MLTE does not handle subclass Carbon events dispatched by the standard handler unless you install the standard handler on the window by calling the Carbon Event Manager function InstallStandardEventHandler or by writing code that performs the tasks done by InstallStandardEventHandler.
MLTE supports four classes of Carbon events:
kEventClassTextInput
kEventClassWindow
kEventClassCommand
kEventClassMenu
The event kinds supported within each class are listed in Table 1. You don’t need to specify event kinds to MLTE; the table is provided so you can see the kind of events that MLTE supports. When you set up support for Carbon events, MLTE handles all the calls to the Carbon Event Manager that actually install and set up the handlers that take care of the Carbon events for a text object. See Inside Mac OS X: Handling Carbon Events and the Carbon Event Manager Reference for more information on Carbon events and for the most recent list of event classes and kinds supported by MLTE.
Event Class |
Event Kind |
Means |
|
|
Text characters produced by a keyboard |
|
Map character index to screen position |
|
|
Map screen position to character index |
|
|
Determine currently selected text |
|
|
Manage contents of an inline input session |
|
|
|
Window activated (brought to front) |
|
Window deactivated (sent behind) |
|
|
Draw window’s contents on screen |
|
|
Mouse click in content region |
|
|
|
Menu item chosen or a control with a command has been pressed |
|
Determine enabled or disabled status of command |
|
|
|
Font selected from a Font menu |
MacTextEditor.hDefines a universal procedure pointer to a contextual menu setup callback function.
typedef TXNContextualMenuSetupProcPtr TXNContextualMenuSetupUPP;
See TXNContextualMenuSetupProcPtr for more information.
MacTextEditor.hContains information about formatting and other settings that control how a text object is displayed or behaves.
union TXNControlData {
UInt32 uValue;
SInt32 sValue;
TXNTab tabValue;
TXNMargins *marginsPtr;
};
typedef union TXNControlData TXNControlData;
uValueA control setting. You should use this field for control settings, except tab and margins, whose value is unsigned.
sValueA control setting. You should use this only for control settings, except tab and margins, whose value is signed. There currently are no control settings whose value is signed.
tabValueA structure that contains tab distance and tab type settings.
marginsPtrA pointer to a TXNMargins structure that specifies the top, left, and right margin settings.
The TXNControlData data type is a parameter in the TXNSetTXNObjectControls and TXNGetTXNObjectControls functions. The data contained in the union is determined by the iControlData parameter of those functions.
MacTextEditor.hDefines result codes. (Deprecated. Use OSStatus instead.)
typedef OSStatus TXNErrors;
MacTextEditor.hDefines a universal procedure pointer to a find callback function.
typedef TXNFindProcPtr TXNFindUPP;
See TXNFindProcPtr for more information.
MacTextEditor.hContains private variables necessary to represent an MLTE Font menu.
typedef struct OpaqueTXNFontMenuObject * TXNFontMenuObject;
Used in the functions TXNNewFontMenuObject, TXNPrepareFontMenu, TXNGetFontMenuHandle, TXNDoFontMenuSelection, and TXNDisposeFontMenuObject.
MacTextEditor.hRepresents the text frame to which actions should be applied.
typedef UInt32 TXNFrameID;
Used in the functions TXNNewObject, TXNActivate, TXNResizeFrame, TXNSetFrameBounds, TXNDragReceiver, and TXNDragTracker.
MacTextEditor.hContains coordinates for a view or text rectangle. (Deprecated. No longer needed.)
struct TXNLongRect {
SInt32 top;
SInt32 left;
SInt32 bottom;
SInt32 right;
};
typedef struct TXNLongRect TXNLongRect;
topThe top coordinate of the rectangle.
leftThe left-side coordinate of the rectangle.
bottomThe bottom coordinate of the rectangle.
rightThe right-side coordinate of the rectangle.
The TXNLongRect data structure is passed as a parameter to the functions TXNSetRectBounds and TXNGetRectBounds, which are deprecated. You should instead use the functions TXNSetHIRectBounds and TXNGetHIRect, which take an HIRect data structure as a parameter instead of a TXNLongRect data structure
MacTextEditor.hContains information about the preferred font, font size, and style for a given text encoding.
struct TXNMacOSPreferredFontDescription {
UInt32 fontID;
Fixed pointSize;
TextEncoding encoding;
Style fontStyle;
};
typedef struct TXNMacOSPreferredFontDescription TXNMacOSPreferredFontDescription;
fontIDThe ID of the preferred font.
pointSizeThe point size of the preferred font.
encodingThe text encoding of the preferred font.
fontStyleThe font style of the preferred font.
Used in the functions TXNInitTextension, TXNSetFontDefaults, and TXNGetFontDefaults.
MacTextEditor.hContains the margin values of a text object.
struct TXNMargins {
SInt16 topMargin;
SInt16 leftMargin;
SInt16 bottomMargin;
SInt16 rightMargin;
};
typedef struct TXNMargins TXNMargins;
topMarginThe location of the top margin. Available in MLTE version 1.2 and later.
leftMarginThe location of the left margin. Available in MLTE version 1.2 and later.
bottomMarginThe location of the bottom margin. This is a placeholder; it is currently not possible to set the bottom margin.
rightMarginThe location of the right margin. Available in MLTE version 1.2 and later.
This structure is used as a field in the TXNControlData union.
MacTextEditor.hContains information about the text to be matched in a find operation.
struct TXNMatchTextRecord {
const void * iTextPtr;
SInt32 iTextToMatchLength;
TextEncoding iTextEncoding;
};
typedef struct TXNMatchTextRecord TXNMatchTextRecord;
iTextPtrA pointer to the text to be matched.
iTextToMatchLengthThe length of text to which the iTextPtr parameter points.
iTextEncodingThe encoding used by the text to be matched.
Used in the TXNFind function and the callback TXNFindProcPtr.
MacTextEditor.hContains private variables and functions necessary to represent text and handle text formatting at a document level.
typedef struct OpaqueTXNObject * TXNObject;
You obtain a structure of type TXNObject from the TXNNewObject function.
MacTextEditor.hContains data specific to your application. (Deprecated. Used only in the TXNNewObject function, which is deprecated.)
typedef void * TXNObjectRefCon;
MacTextEditor.hDefines a universal procedure pointer to a scroll callback function.
typedef TXNScrollInfoProcPtr TXNScrollInfoUPP;
See TXNScrollInfoProcPtr for more information.
MacTextEditor.hContains tab information for a text object.
struct TXNTab {
SInt16 value;
TXNTabType tabType;
UInt8 filler;
};
typedef struct TXNTab TXNTab;
valueThe distance between tabs.
tabTypeThe type of tab settings, such as right or left. See Tab Types for a description of possible values.
fillerAn unsigned 8-bit integer that exists only to make the structure exactly 4 bytes in size.
Passed in the iControlData parameter of the TXNSetTXNObjectControls function when the value of the iControlTags parameter is kTXNTabSettingsTag, or returned in the oControlData parameter of the TXNGetTXNObjectControls function when the value of the iControlTags parameter is kTXNTabSettingsTag.
MacTextEditor.hContains information about how text appears in a Unicode text box.
struct TXNTextBoxOptionsData {
TXNTextBoxOptions optionTags;
Fract flushness;
Fract justification;
Fixed rotation;
void * options;
};
typedef struct TXNTextBoxOptionsData TXNTextBoxOptionsData;
optionTagsSpecifies the field in this structure at which MLTE should look. See Text Box Options Masks for a description of possible values. You must supply the data associated with this tag in the appropriate field. For example, if you set the value of the optionTags field to kTXNSetJustificationMask, you must specify the type of justification in the justification field.
flushnessIndicates whether text should be displayed flush left, flush right, or centered in the text box. You should use one of the line justification constants defined in ATSUnicode.h. The possible values are kATSUStartAlignment, kATSUEndAlignment, and kATSUCenterAlignment.
justificationThe type of justification to use in the text box. You should use one of the line justification constants defined in ATSUnicode.h. The possible values are kATSUNoJustification and kATSUFullJustification.
rotationThe angle of rotation for text in the text box.
optionsReserved for future use. This should be set to NULL.
Used in the TXNDrawUnicodeTextBox and TXNDrawCFStringTextBox functions.
MacTextEditor.hContains information about attributes for a text object.
struct TXNTypeAttributes {
TXTNTag tag;
ByteCount size;
TXNAttributeData data;
};
typedef struct TXNTypeAttributes TXNTypeAttributes;
tagA value that specifies the type of information contained in the data field. See Font Run Attributes for a description of possible values.
sizeThe size of the attribute. See Font Run Attribute Sizes for a description of possible values.
dataA union that serves either as a 32-bit integer or a 32-bit pointer, depending on the size field.
Used in the functions TXNSetTypeAttributes, TXNGetContinuousTypeAttributes, and TXNGetIndexedRunInfoFromRange.
MacTextEditor.hSpecifies the version of MLTE in use.
typedef UInt32 TXNVersionValue;
Returned by the TXNVersionInformation function.
MacTextEditor.hSpecifies the type of information you want passed in the data field of the TXNTypeAttributes structure. (Deprecated. Use TXNTypeRunAttributes.)
typedef FourCharCode TXTNTag;
MacTextEditor.hSpecify constants for actions used when calling TXNCanUndoAction and TXNCanRedoAction.
const CFStringRef kTXNActionTyping; const CFStringRef kTXNActionCut; const CFStringRef kTXNActionPaste; const CFStringRef kTXNActionClear; const CFStringRef kTXNActionChangeFont; const CFStringRef kTXNActionChangeColor; const CFStringRef kTXNActionChangeSize; const CFStringRef kTXNActionChangeStyle; const CFStringRef kTXNActionAlignLeft; const CFStringRef kTXNActionAlignCenter; const CFStringRef kTXNActionAlignRight; const CFStringRef kTXNActionDrop; const CFStringRef kTXNActionMove; const CFStringRef kTXNActionChangeFontFeature; const CFStringRef kTXNActionChangeFontVariation; const CFStringRef kTXNActionChangeGlyphVariation; const CFStringRef kTXNActionChangeTextPosition; const CFStringRef kTXNActionUndoLast;
kTXNActionTypingA typing action.
kTXNActionCutA cut action.
kTXNActionPasteA paste action.
kTXNActionClearA clear action.
kTXNActionChangeFontA font change action.
kTXNActionChangeColorA color change action.
kTXNActionChangeSizeA size change action.
kTXNActionChangeStyleA change in style action.
kTXNActionAlignLeftAn align left action.
kTXNActionAlignCenterAn align center action.
kTXNActionAlignRightAn align right action.
kTXNActionDropA drop action.
kTXNActionMoveA move action.
kTXNActionChangeFontFeatureA change font feature action.
kTXNActionChangeFontVariationA change in font variation action.
kTXNActionChangeGlyphVariationA change glyph variation action.
kTXNActionChangeTextPositionA change text position action; includes changing the space before and after characters and shifting the text’s baseline.
kTXNActionUndoLastUsed in undo and redo functions if none of the other constants apply.
Use these constants when calling the TXNCanUndoAction and TXNCanRedoAction functions.
MacTextEditor.hRepresent action types use by TXNGetCountForActionType and TXNClearCountForActionType.
const CFStringRef kTXNActionCountOfTextChanges; const CFStringRef kTXNActionCountOfStyleChanges; const CFStringRef kTXNActionCountOfAllChanges;
kTXNActionCountOfTextChangesCount of text changes. All text changes other than style changes and custom defined actions are included in this action count. Includes key presses, inline sessions, cut, copy, and paste, and drop. Undo and redo events of these kinds are also included in this action count.
kTXNActionCountOfStyleChangesCount of text style changes. Style changes include changing font, font face, font size, font feature, font variation, font color, glyph variation, and text position. Undo or redo events of these kinds are also included in this action count.
kTXNActionCountOfAllChangesTotal count of actions including all text and style changes, as well as custom defined actions.
MacTextEditor.hSpecify actions to be included in an action count when calling TXNGetActionChangeCount and TXNClearActionChangeCount. (Deprecated. See Action Count Constants.)
enum {
kTXNTextInputCountBit = 0,
kTXNRunCountBit = 1
};
kTXNTextInputCountBitWhen this bit is set, general text input events that affect the content of the document are included in the action count. General text input events include key presses, inline sessions, pasting, cutting, dropping, and other editing events. Undo or redo events of text input events are also included in the action count.
Available in Mac OS X v10.1 and later.
Declared in MacTextEditor.h.
kTXNRunCountBitWhen this bit is set, general style changes to the text are included in the action count. Style changes include changes to the text face, font, font size and so forth. Undo and redo events of style changes are also included in the action count.
Available in Mac OS X v10.1 and later.
Declared in MacTextEditor.h.
MacTextEditor.hSet or test action count bits for use with TXNGetActionChangeCount and TXNClearActionChangeCount. (Deprecated. See Action Count Constants.)
typedef OptionBits TXNCountOptions; enum { kTXNTextInputCountMask = 1L << kTXNTextInputCountBit, kTXNRunCountMask = 1L << kTXNRunCountBit, kTXNAllCountMask = kTXNTextInputCountMask | kTXNRunCountMask };
kTXNTextInputCountMaskUse to set or test for the kTXNTextInputCountBit.
Available in Mac OS X v10.1 and later.
Declared in MacTextEditor.h.
kTXNRunCountMaskUsed to set or test for the kTXNRunCountBit.
Available in Mac OS X v10.1 and later.
Declared in MacTextEditor.h.
kTXNAllCountMaskUse to set or text for both kTXNTextInputCountBit and kTXNRunCountBit.
Available in Mac OS X v10.1 and later.
Declared in MacTextEditor.h.
MacTextEditor.hSpecify constants for editing actions taken by the user in versions of Mac OS X prior to Mac OS X v10.4. (Deprecated. These constants were used in the TXNCanUndo and TXNCanRedo functions, which are deprecated in Mac OS X v10.4. Use the TXNCanUndoAction and TXNCanRedoAction functions instead.)
typedef UInt32 TXNActionKey;
enum {
kTXNTypingAction = 0,
kTXNCutAction = 1,
kTXNPasteAction = 2,
kTXNClearAction = 3,
kTXNChangeFontAction = 4,
kTXNChangeFontColorAction = 5,
kTXNChangeFontSizeAction = 6,
kTXNChangeStyleAction = 7,
kTXNAlignLeftAction = 8,
kTXNAlignCenterAction = 9,
kTXNAlignRightAction = 10,
kTXNDropAction = 11,
kTXNMoveAction = 12,
kTXNFontFeatureAction = 13,
kTXNFontVariationAction = 14,
kTXNUndoLastAction = 1024
};
kTXNTypingActionA typing action.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNCutActionA cut action.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNPasteActionA paste action.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNClearActionA clear action.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNChangeFontActionA font change action.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNChangeFontColorActionA change in font color action.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNChangeFontSizeActionA change in font size action.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNChangeStyleActionA change in font style action.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNAlignLeftActionAn align left action.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNAlignCenterActionAn align center action.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNAlignRightActionAn align right action.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNDropActionA drop action.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNMoveActionA move selection action.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNFontFeatureActionA change in font feature action.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNFontVariationActionA change in font variation action.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNUndoLastActionUse this if none of the other constants apply.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
MacTextEditor.hSpecify whether Apple events should be used.
enum {
kTXNNoAppleEventHandlersBit = 0,
kTXNRestartAppleEventHandlersBit = 1
};
kTXNNoAppleEventHandlersBitWhen this bit is set, Apple event handlers are not used. (Deprecated. There is no replacement.)
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNRestartAppleEventHandlersBitWhen this bit is set, Apple event handlers are started up. (Deprecated. There is no replacement.)
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
MLTE does not support Apple events in Mac OS X version 10.1 and later.
MacTextEditor.hSet or test Apple event handler bits.
enum {
kTXNNoAppleEventHandlersMask = 1 << kTXNNoAppleEventHandlersBit,
kTXNRestartAppleEventHandlersMask = 1 << kTXNRestartAppleEventHandlersBit
};
kTXNNoAppleEventHandlersMaskUse to set or test for the kTXNNoAppleEventHandlersBit. Use this if you want Apple event handlers removed. (Deprecated. There is no replacement.)
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNRestartAppleEventHandlersMaskUsed to set or test for the kTXNRestartAppleEventHandlersBit. Use this if you want to subsequently restart Apple event handlers after removing your own text handlers. (Deprecated. There is no replacement.)
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
These constants are currently the only settings for the flags field of TXNCarbonEventInfo.
MLTE does not support Apple events in Mac OS X version 10.1 and later
MacTextEditor.hSpecify the default imaging system.
enum {
kTXNWillDefaultToATSUIBit = 0,
kTXNWillDefaultToCarbonEventBit = 1
};
kTXNWillDefaultToATSUIBitWhen this bit is set, indicates ATSUI is the default imaging system.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNWillDefaultToCarbonEventBitWhen this bit is set, indicates MLTE uses Carbon events by default.
Available in Mac OS X v10.1 and later.
Declared in MacTextEditor.h.
MacTextEditor.hSpecifies new features and represents the default imaging system.
typedef OptionBits TXNFeatureBits; enum { kTXNWillDefaultToATSUIMask = 1L << kTXNWillDefaultToATSUIBit, kTXNWillDefaultToCarbonEventMask = 1L << kTXNWillDefaultToCarbonEventBit };
kTXNWillDefaultToATSUIMaskTest for ATSUI as the default imaging system.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNWillDefaultToCarbonEventMaskTest for Carbon events as the default event handling mechanism.
Available in Mac OS X v10.1 and later.
Declared in MacTextEditor.h.
You can use this to test for bit 0 in the oFeatureFlags parameter returned by the TXNVersionInformation function.
MacTextEditor.hSpecify the automatic indentation setting for a text object.
enum {
kTXNAutoIndentOff = false,
kTXNAutoIndentOn = true
};
kTXNAutoIndentOffAutomatic indenting is not enabled.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNAutoIndentOnAutomatic indenting is enabled. You can enable this feature only if automatic word wrapping is not enabled.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
Passed in the iControlData parameter of the TXNSetTXNObjectControls function when the value of the iControlTags parameter is kTXNAutoIndentStateTag, or returned in the oControlData parameter of the TXNGetTXNObjectControls function when the value of the iControlTags parameter is kTXNAutoIndentStateTag.
MacTextEditor.hSpecify automatic scrolling behavior for a text object.
enum {
kTXNAutoScrollInsertionIntoView = 0,
kTXNAutoScrollNever = 1,
kTXNAutoScrollWhenInsertionVisible = 2
};
typedef UInt32 TXNAutoScrollBehavior;
kTXNAutoScrollInsertionIntoViewThe default auto scrolling behavior. When text is inserted, the document is scrolled to show the new insertion. This was the only type of autoscrolling prior to Mac OS X v10.4.
Available in Mac OS X v10.4 and later.
Declared in MacTextEditor.h.
kTXNAutoScrollNeverNever autoscroll, even when dragging the mouse or inserting text. The only way to scroll the document is for the user to use the scrollbar or to scroll programatically.
Available in Mac OS X v10.4 and later.
Declared in MacTextEditor.h.
kTXNAutoScrollWhenInsertionVisibleAutoscrolling only happens when the insertion offset is currently in the user’s view. If the user is looking at the first page of a ten page document and text is inserted at the end of the document, no autoscrolling occurs. However, if the user was looking at page ten and text is inserted there, the document would scroll. This type of autoscrolling is best for implementing terminal or log windows.
Available in Mac OS X v10.4 and later.
Declared in MacTextEditor.h.
MacTextEditor.hSpecify Carbon events to be handled by MLTE.
#define kTXNTextHandlerKey CFSTR("TextInput") #define kTXNWindowEventHandlerKey CFSTR("WindowEvent") #define kTXNWindowResizeEventHandlerKey CFSTR("WindowResize") #define kTXNCommandTargetKey CFSTR("CommandTarget") #define kTXNCommandUpdateKey CFSTR("CommandUpdate") #define kTXNFontMenuObjectKey CFSTR("FontMenuObject") #define kTXNActionNameMapperKey CFSTR("ActionNameMapper") #define kTXNWheelMouseEventHandlerKey CFSTR("WheelMouseEvent") #define kTXNTSMDocumentAccessHandlerKey CFSTR("TSMDocumentAccess") #define kTXNFontPanelEventHandlerKey CFSTR("FontPanel") #define kTXNFontMenuRefKey CFSTR("FontMenuRef") #define kTXNActionKeyMapperKey CFSTR("ActionKeyMapper")
kTXNTextHandlerKeyIndicates the Carbon event class kEventClassTextInput and the event kinds kEventTextInputUpdateActiveInputArea, kEventTextInputUnicodeForKeyEvent, kEventTextInputOffsetToPos, kEventTextInputPosToOffset, and kEventTextInputGetSelectedText.
kTXNWindowEventHandlerKeyIndicates the Carbon event class kEventClassWindow and the event kinds kEventWindowActivated, kEventWindowDeactivated, kEventWindowDrawContent, and kEventWindowClickContentRegion.
kTXNWindowResizeEventHandlerKeyIndicates the Carbon event class kEventClassWindow and a window resizing event.
kTXNCommandTargetKeyIndicates the Carbon event class kEventClassCommand and the event kind kEventCommandProcess.
kTXNCommandUpdateKeyIndicates the Carbon event class kEventClassCommand and the event kind kEventCommandUpdate.
kTXNFontMenuObjectKeyIndicates the Carbon event class kEventClassMenu and the event kind kEventMenuEnableItems.
kTXNActionNameMapperKeyIndicates an action key mapper callback function. Available in Mac OS X v10.4; use instead of kTXNActionKeyMapperKey.
kTXNWheelMouseEventHandlerKeyIndicates the handler for wheel mouse events.
kTXNTSMDocumentAccessHandlerKeyIndicates the handler for TSM document access events.
kTXNFontPanelEventHandlerKeyIndicates the handler for Font Panel events.
kTXNFontMenuRefKeyIndicates the Carbon event class kEventClassMenu.
kTXNActionKeyMapperKeyIndicates an action key mapper callback function. (Deprecated. Use kTXNActionNameMapperKey instead.)
MacTextEditor.hClear formatting and privileges settings.
enum {
kTXNClearThisControl = 0xFFFFFFFF,
kTXNClearTheseFontFeatures = 0x80000000
};
kTXNClearThisControlClears control settings. If you want to clear a setting associated with a control tag, you can call the TXNSetTXNObjectControls function with the value of the iControlData parameter set to kTXNClearThisControl. MLTE resets the value of the control specified in the iControlTag parameter of the TXNSetTXNObjectControls function to the default value for that control.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNClearTheseFontFeaturesClears font feature settings. You can use this constant when you call the TXNSetTypeAttributes function to clear all of the ATSUI font features or ATSUI font variations.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
MacTextEditor.hSpecify options for enabling support for command events in a TXNObject.
enum {
kTXNSupportEditCommandProcessing = 1 << 0,
kTXNSupportEditCommandUpdating = 1 << 1,
kTXNSupportSpellCheckCommandProcessing = 1 << 2,
kTXNSupportSpellCheckCommandUpdating = 1 << 3,
kTXNSupportFontCommandProcessing = 1 << 4,
kTXNSupportFontCommandUpdating = 1 << 5
};
typedef UInt32 TXNCommandEventSupportOptions;
kTXNSupportEditCommandProcessingSetting this bit when calling TXNSetTXNObjectControls enables support for processing the menu item associated with kHICommandUndo, kHICommandRedo, kHICommandCut, kHICommandCopy, kHICommandPaste, kHICommandClear, and kHICommandSelectAll. If this bit is not set when TXNSetTXNObjectControls is called, support is disabled.
Available in Mac OS X v10.4 and later.
Declared in MacTextEditor.h.
kTXNSupportEditCommandUpdatingSetting this bit when calling TXNSetTXNObjectControls enables support for updating the menu item associated with kHICommandUndo, kHICommandRedo, kHICommandCut, kHICommandCopy, kHICommandPaste, kHICommandClear, and kHICommandSelectAll. For Undo, the item is enabled if there are any undoable actions in MLTE’s command stack, and, if you have installed an action key mapper proc, it is called to get the appropriate string for the Undo item. For Redo, the item is enabled if there are any redoable actions; if you have installed an action key mapper callback, it is called to get the appropriate string for the Redo item. For Cut and Clear, the item is enabled if there is current selection that is not empty; otherwise, these items are disabled. For Paste, the item is enabled if the clipboard is not empty; it is disabled if the clipboard is empty or contains data that MLTE cannot parse. For Select All, the item is always updated. If this bit is not set when TXNSetTXNObjectControls is called, support is disabled.
Available in Mac OS X v10.4 and later.
Declared in MacTextEditor.h.
kTXNSupportSpellCheckCommandProcessingSetting this bit when calling TXNSetTXNObjectControls enables support for spell checking. The spell checking commands supported are: Show Spelling Panel ('shsp'), Check Spelling ('cksp'), Change Spelling ('chsp'), enable check spelling as you type ('aspc'), ignore spelling ('igsp'), and learn spelling ('lrwd'). If this bit is not set when TXNSetTXNObjectControls is called, support is disabled.
Available in Mac OS X v10.4 and later.
Declared in MacTextEditor.h.
kTXNSupportSpellCheckCommandUpdatingEnables support for updating the menu item associated with a given spell checking command. Once kTXNSupportSpellCheckCommandUpdating is enabled, the Show Spelling and Check Spelling items are always enabled. The Change Spelling item is included in a spelling menu only if the current selection is a misspelled word; it is disabled if the current selection is empty or not a misspelled word. The Check Spelling as You Type item is always enabled. It is checked if this feature has been enabled. By default when you turn on spell checking, this item is enabled. If this feature has been disabled, the item is not checked. Ignore Spelling usually does not have a corresponding menu item. If a menu does have this item, Ignore Spelling is disabled if the current selection is empty or is not a misspelled word. It is enabled if the current selection is a misspelled word. Learn Spelling typically does not have a corresponding menu item. If a menu does have this item, Learn Spelling is disabled if the current selection is empty or is not a misspelled word. It is enabled if the current selection is a misspelled word. If this bit is not set when TXNSetTXNObjectControls is called, support is disabled.
Available in Mac OS X v10.4 and later.
Declared in MacTextEditor.h.
kTXNSupportFontCommandProcessingSetting this bit enables Carbon Font Panel support. Once enabled, MLTE handles the following Carbon Events defined in FontPanel.h: kHICommandShowHideFontPanel and kEventFontPanelClosed to show and hide the Carbon font panel, kEventFontSelection event to update the document after the selection of a new font, size, style, color, or any feature settings from the Typography Panel. If this bit is not set when TXNSetTXNObjectControls is called, support is disabled.
Available in Mac OS X v10.4 and later.
Declared in MacTextEditor.h.
kTXNSupportFontCommandUpdatingSetting this bit enables support for updating the selection in Carbon Font Panel when the current selection in an MLTE document is changed. When this bit is set, kTXNSupportFontCommandProcessing must also be set. If this bit is not set when TXNSetTXNObjectControls is called, support is disabled.
Available in Mac OS X v10.4 and later.
Declared in MacTextEditor.h.
MacTextEditor.hSpecify whether font information is continuous.
enum {
kTXNFontContinuousBit = 0,
kTXNSizeContinuousBit = 1,
kTXNStyleContinuousBit = 2,
kTXNColorContinuousBit = 3
};
kTXNFontContinuousBitWhen this bit is set, the font is continuous in a text run.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNSizeContinuousBitWhen this bit is set, the font size is continuous in a text run.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNStyleContinuousBitWhen this bit is set, the font style is continuous in a text run.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNColorContinuousBitWhen this bit is set, the font color is continuous in a text run.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
MacTextEditor.hRepresents continuous style information needed by your application.
typedef OptionBits TXNContinuousFlags; enum { kTXNFontContinuousMask = 1L << kTXNFontContinuousBit, kTXNSizeContinuousMask = 1L << kTXNSizeContinuousBit, kTXNStyleContinuousMask = 1L << kTXNStyleContinuousBit, kTXNColorContinuousMask = 1L << kTXNColorContinuousBit };
kTXNFontContinuousMaskUse to test for continuous font information in a text run.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNSizeContinuousMaskUse to test for continuous size information in a text run.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNStyleContinuousMaskUse to test for continuous style information in a text run.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNColorContinuousMaskUse to test for continuous color information in a text run.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
Used in the TXNGetContinuousTypeAttributes function.
MacTextEditor.hSpecifies offsets to use when manipulating data in a text object. Offsets in MLTE are always character offsets.
typedef UInt32 TXNOffset;
enum {
kTXNUseCurrentSelection = 0xFFFFFFFF,
kTXNStartOffset = 0,
kTXNEndOffset = 0x7FFFFFFF
};
kTXNUseCurrentSelectionUse the current selection.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNStartOffsetThe first offset of the text in a text object.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNEndOffsetThe last offset of the text in a text object.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
These constants can be passed and returned in functions that have the parameter of type TXNOffset.
MacTextEditor.hSpecifies constants used as key values in Data Option dictionaries.
const CFStringRef kTXNPlainTextDocumentType const CFStringRef kTXNMLTEDocumentType const CFStringRef kTXNRTFDocumentType const CFStringRef kTXNQuickTimeDocumentType
kTXNPlainTextDocumentTypePlain text document.
kTXNMLTEDocumentTypeNative MLTE document type.
kTXNRTFDocumentTypeRich text format (RTF) document type.
kTXNQuickTimeDocumentTypeMultimedia file that can be opened by QuickTime importers. This document type is only supported for reading data, not for writing data.
These constants are passed in Data Option dictionary keys to TXNReadFromCFURL and TXNWriteRangeToCFURL to specify options that are to be used when reading data into a TXNObject and when writing data from a TXNObject to a file or special file bundle (directory).
MacTextEditor.hSpecifies keys for use in dictionaries passed as parameters to TXNReadFromCFURL and TXNWriteRangeToCFURL.
const CFStringRef kTXNDataOptionDocumentTypeKey const CFStringRef kTXNDataOptionCharacterEncodingKey
kTXNDataOptionDocumentTypeKeyCFString specifying the document format. The following constants are supported: kTXNPlainTextDocumentType, kTXNMLTEDocumentType, kTXNRTFDocumentType, and kTXNQuickTimeDocumentType. For information on these constants, see Data Option Key Value Constants.
kTXNDataOptionCharacterEncodingKeyCFNumber of type kCFNumberSInt32Type containing the character encoding as specified in CFString.h and CFStringEncodingExt.h.
Data options are used to specify options for reading in and writing out data.
MacTextEditor.hSpecifies the default font name.
enum {
kTXNDefaultFontName = 0
};
MLTE used these constants in an earlier version in which only a single font was allowed. You can now specify an array of font descriptions by using the TXNMacOSPreferredFontDescription structure. See the function TXNInitTextension for a description of how to specify defaults for a font.
MacTextEditor.hSpecifies the default font size.
enum {
kTXNDefaultFontSize = 0x000C0000
};
kTXNDefaultFontSizeSets default font size.
Available in Mac OS X v10.1 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
MacTextEditor.hSpecifies the default font style.
enum {
kTXNDefaultFontStyle = normal
};
kTXNDefaultFontStyleSets default font style.
Available in Mac OS X v10.1 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
MacTextEditor.hSpecify dictionary keys for document attribute dictionaries used by TXNWriteRangeToCFURL and TXNReadFromCFURL.
const CFStringRef kTXNDocumentAttributeTitleKey; const CFStringRef kTXNDocumentAttributeCompanyNameKey; const CFStringRef kTXNDocumentAttributeSubjectKey; const CFStringRef kTXNDocumentAttributeAuthorKey; const CFStringRef kTXNDocumentAttributeKeywordsKey; const CFStringRef kTXNDocumentAttributeCommentKey; const CFStringRef kTXNDocumentAttributeEditorKey; const CFStringRef kTXNDocumentAttributeCreationTimeKey; const CFStringRef kTXNDocumentAttributeModificationTimeKey; const CFStringRef kTXNDocumentAttributeCopyrightKey;
kTXNDocumentAttributeTitleKeyCFString containing the document’s title.
kTXNDocumentAttributeCompanyNameKeyCFString containing the company name.
kTXNDocumentAttributeSubjectKeyCFString containing the document’s subject.
kTXNDocumentAttributeAuthorKeyCFString containing the name of the document’s author.
kTXNDocumentAttributeKeywordsKeyCFArray of values of type CFString containing keywords.
kTXNDocumentAttributeCommentKeyCFString containing comments.
kTXNDocumentAttributeEditorKeyCFString containing the name of the person who last edited the document.
kTXNDocumentAttributeCreationTimeKeyCFAbsoluteTime containing document comments; note that this is not the file system creation date of the file, but of the document, as it is stored in the document.
kTXNDocumentAttributeModificationTimeKeyCFAbsoluteTime containing the last modification date of the document contents.
kTXNDocumentAttributeCopyrightKeyCFString containing the copyright of the document.
Use these constants when working with document attribute dictionaries that are passed to TXNWriteRangeToCFURL and TXNReadFromCFURL.
When writing data out, document attributes are embedded into the data stream for document formats that support them (i.e. MLTE native format and RTF). When reading data in, document attributes are extracted from the data stream if the document format supports them.
MacTextEditor.hSpecify whether or not drag and drop is enabled.
enum {
kTXNEnableDragAndDrop = false,
kTXNDisableDragAndDrop = true
};
kTXNEnableDragAndDropEnables drag and drop when passed as a parameter to the function TXNSetTXNObjectControls. Indicates drag and drop is disabled when returned from the function TXNGetTXNObjectControls.
Available in Mac OS X v10.1 and later.
Declared in MacTextEditor.h.
kTXNDisableDragAndDropDisables drag and drop when passed as a parameter to the function TXNSetTXNObjectControls. Indicates drag and drop is enabled when returned from the function TXNGetTXNObjectControls.
Available in Mac OS X v10.1 and later.
Declared in MacTextEditor.h.
MacTextEditor.hSpecify which elements of the text object to render.
enum {
kTXNDrawItemScrollbarsBit= 0,
kTXNDrawItemTextBit= 1,
kTXNDrawItemTextAndSelectionBit = 2
};
kTXNDrawItemScrollbarsBitSpecifies to draw the scroll bars.
Available in Mac OS X v10.3 and later.
Declared in MacTextEditor.h.
kTXNDrawItemTextBitSpecifies to render the text.
Available in Mac OS X v10.3 and later.
Declared in MacTextEditor.h.
kTXNDrawItemTextAndSelectionBitSpecifies to render the text and the current selection.
Available in Mac OS X v10.3 and later.
Declared in MacTextEditor.h.
See Draw Items Masks.
MacTextEditor.hTest for draw-items bits.
enum {
kTXNDrawItemScrollbarsMask = 1UL << kTXNDrawItemScrollbarsBit,
kTXNDrawItemTextMask = 1UL << kTXNDrawItemTextBit,
kTXNDrawItemTextAndSelectionMask = 1UL << kTXNDrawItemTextAndSelectionBit,
kTXNDrawItemAllMask = 0xFFFFFFFF
};
typedef OptionBits TXNDrawItems;
kTXNDrawItemScrollbarsMaskUse to set or test for the kTXNDrawItemScrollbarsBit.
Available in Mac OS X v10.3 and later.
Declared in MacTextEditor.h.
kTXNDrawItemTextMaskUsed to set or test for the kTXNDrawItemTextBit.
Available in Mac OS X v10.3 and later.
Declared in MacTextEditor.h.
kTXNDrawItemTextAndSelectionMaskUse to set or text for the kTXNDrawItemTextAndSelectionBit.
Available in Mac OS X v10.3 and later.
Declared in MacTextEditor.h.
kTXNDrawItemAllMaskUsed to set all draw-items bits or test to see whether all draw-items bits are set. Setting all bits specifies to draw the scroll bars, text, and the current selection.
Available in Mac OS X v10.3 and later.
Declared in MacTextEditor.h.
These constants can be passed as parameters to the function TXNDrawObject .
MacTextEditor.hSpecify a variety of font settings.
enum {
kTXNDontCareTypeSize = 0xFFFFFFFF,
kTXNDontCareTypeStyle = 0xFF,
kTXNIncrementTypeSize = 0x00000001,
kTXNDecrementTypeSize = 0x80000000,
kTXNUseScriptDefaultValue = -1,
kTXNNoFontVariations = 0x7FFF
};
kTXNDontCareTypeSizeUse the application default font size.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNDontCareTypeStyleUse “normal” should as the font style.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNIncrementTypeSizeIncrease the font size should by one point.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNDecrementTypeSizeDecrease the font size by one point.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
These constants can be used as parameters in a variety of functions that control font attributes, such as the TXNSetFontDefaults and TXNSetTypeAttributes functions.
MacTextEditor.hSpecifies a font attribute (font family, size, style, and so forth) for a text run in a text object.
typedef FourCharCode TXNTypeRunAttributes; enum { kTXNQDFontNameAttribute = 'fntn', kTXNQDFontFamilyIDAttribute = 'font', kTXNQDFontSizeAttribute = 'size', kTXNQDFontStyleAttribute = 'face', kTXNQDFontColorAttribute = 'klor', kTXNTextEncodingAttribute = 'encd', kTXNATSUIFontFeaturesAttribute = 'atfe', kTXNATSUIFontVariationsAttribute = 'atva', kTXNURLAttribute = 'urla' kTXNATSUIStyle = 'astl' };
kTXNQDFontNameAttributeSpecifies that the data field of the TXNTypeAttributes structure contains a font name.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNQDFontFamilyIDAttributeSpecifies that the data field of the TXNTypeAttributes structure contains a font family ID.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNQDFontSizeAttributeSpecifies that the data field of the TXNTypeAttributes structure contains a font size. Obsolete; incorrect font sizes are always returned as a fixed value. (Deprecated. Use kTXNFontSizeAttribute instead.)
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNQDFontStyleAttributeSpecifies that the data field of the TXNTypeAttributes structure contains a font style.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNQDFontColorAttributeSpecifies that the data field of the TXNTypeAttributes structure contains a font color.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNTextEncodingAttributeSpecifies that the data field of the TXNTypeAttributes structure contains a text encoding.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNATSUIFontFeaturesAttributeSpecifies that the data field of the TXNTypeAttributes structure contains ATSUI font features.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNURLAttributeSpecifies that the data field of the TXNTypeAttributes structure contains a URL.
Available in Mac OS X v10.2 and later.
Declared in MacTextEditor.h.
kTXNATSUIStyleSpecifies that the data field of the TXNTypeAttributes structure contains an ATSUI style.
Available in Mac OS X v10.3 and later.
Declared in MacTextEditor.h.
You pass these constants in the tag field of the TXNTypeAttributes structure. You can supplement these with the style attributes defined for ATSUI.
MacTextEditor.hDescribes the size of a font attribute.
typedef ByteCount TXNTypeRunAttributeSizes;
enum {
kTXNQDFontNameAttributeSize = sizeof(Str255),
kTXNQDFontFamilyIDAttributeSize = sizeof(SInt16),
kTXNQDFontSizeAttributeSize = sizeof(SInt16),
kTXNQDFontStyleAttributeSize = sizeof(Style),
kTXNQDFontColorAttributeSize = sizeof(RGBColor),
kTXNTextEncodingAttributeSize = sizeof(TextEncoding),
kTXNFontSizeAttributeSize = sizeof(Fixed),
kTXNATSUIStyleSize = sizeof(ATSUStyle)
};
kTXNQDFontNameAttributeSizeThe size of a QuickDraw font name.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNQDFontFamilyIDAttributeSizeThe size of a font family ID attribute.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNQDFontSizeAttributeSizeObsolete don’t use. (Deprecated. Instead, use kTXNFontSizeAttributeSize.)
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNQDFontStyleAttributeSizeThe size of font style attribute.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNQDFontColorAttributeSizeThe size of a font color attribute.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNTextEncodingAttributeSizeThe size of text encoding attribute.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNFontSizeAttributeSizeThe size of the font size attribute. Use this instead of the kTXNQDFontSizeAttributeSize constant. Font sizes are always returned as a Fixed value.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNATSUIStyleSizeThe size of the ATSUI style attribute.
Available in Mac OS X v10.3 and later.
Declared in MacTextEditor.h.
You pass these constants in the size field of the TXNTypeAttributes structure.
MacTextEditor.hSpecifies the formatting and privileges information to get from or set for a text object.
typedef FourCharCode TXNControlTag; enum { kTXNLineDirectionTag = 'lndr', kTXNJustificationTag = 'just', kTXNIOPrivilegesTag = 'iopv', kTXNSelectionStateTag = 'slst', kTXNInlineStateTag = 'inst', kTXNWordWrapStateTag = 'wwrs', kTXNKeyboardSyncStateTag = 'kbsy', kTXNAutoIndentStateTag = 'auin', kTXNTabSettingsTag = 'tabs', kTXNRefConTag = 'rfcn', kTXNMarginsTag = 'marg', kTXNFlattenMoviesTag = 'flat', kTXNDoFontSubstitution = 'fSub', kTXNNoUserIOTag = 'nuio', kTXNUseCarbonEvents = 'cbcb', kTXNDrawCaretWhenInactiveTag = 'dcrt', kTXNDrawSelectionWhenInactiveTag = 'dsln', kTXNDisableDragAndDropTag = 'drag', kTXNSingleLevelUndoTag = 'undo', kTXNVisibilityTag = 'visb' kTXNDisableLayoutAndDrawTag = kTXNVisibilityTag, kTXNAutoScrollBehaviorTag = ‘sbev’ };
kTXNLineDirectionTagSpecifies a setting for the direction text is written on the line. If you pass this constant in the iControlTags parameter of the TXNSetTXNObjectControls function, you must also pass a value that specifies the line direction in the iControlData parameter. See Line Direction Settings for a description of possible values.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNJustificationTagSpecifies a justification setting. If you pass this constant in the iControlTags parameter of the TXNSetTXNObjectControls function, you must also pass a value that specifies a justification setting in the iControlData parameter. See Justification Settings for a description of possible values.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNIOPrivilegesTagIndicates a privileges setting. If you pass this constant in the iControlTags parameter of the TXNSetTXNObjectControls function, you must also pass a value that specifies a privileges setting in the iControlData parameter. See Read and Write Privileges Settings for a description of possible values.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNSelectionStateTagSpecifies a selection state; that is, whether MLTE displays a cursor and allows selections in a read-only document. If you pass this constant in the iControlTags parameter of the TXNSetTXNObjectControls function, you must also pass a value that specifies the selection state in the iControlData parameter. See Selection State Settings for a description of possible values.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNInlineStateTagSpecifies an inline state that is, whether text is input through the document’s window (inline) or through a small floating window that appears at the bottom of the screen. If you pass this constant in the iControlTags parameter of the TXNSetTXNObjectControls function, you must also pass a value that specifies the inline state in the iControlData parameter. See Inline State Settings for a description of possible values.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNWordWrapStateTagSpecifies a word-wrap setting. If you pass this constant in the iControlTags parameter of the TXNSetTXNObjectControls function, you must also pass a value that specifies the line-wrapping state in the iControlData parameter. See Line Wrapping Settings for a description of possible values.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNKeyboardSyncStateTagSpecifies whether to synchronize the keyboard with the font setting. If you pass this constant in the iControlTags parameter of the TXNSetTXNObjectControls function, you must also pass a value that specifies the keyboard synchronization state in the iControlData parameter. See Keyboard Synchronization Settings for a description of possible values.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNAutoIndentStateTagSpecifies an automatic indentation setting. This is available only when word warp is turned off. If you pass this constant in the iControlTags parameter of the TXNSetTXNObjectControls function, you must also pass a value that specifies the indentation state in the iControlData parameter. See Automatic Indentation Settings for a description of possible values.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNTabSettingsTagSpecifies a tab width setting. If you pass this constant in the iControlTags parameter of the TXNSetTXNObjectControls function, you must also pass a TXNTab structure in the iControlData parameter.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNRefConTagAn application-specific constant you define.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNMarginsTagSpecifies margin settings. If you pass this constant in the iControlTags parameter of the TXNSetTXNObjectControls function, you must also pass a pointer to a TXNMargins structure in the iControlData parameter. You use this structure to specify the top, left, and right margin settings.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNFlattenMoviesTagSpecifies whether to flattens movies. A flattened movie is self-contained. If you don’t flatten a movie, it can’t be played unless any external files (such as audio or image files) on which it depends are available. If you pass this constant in the iControlTags parameter of the TXNSetTXNObjectControls function, you must also pass a Boolean value in the iControlData parameter that specifies whether to enable (true) or disable (false) movie flattening.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNDoFontSubstitutionSpecifies a font substitution setting. If you pass this constant in the iControlTags parameter of the TXNSetTXNObjectControls function, you must also pass a Boolean value in the iControlData parameter that specifies whether to enable (true) or disable (false) font substitution. For best performance, don’t enable font substitution.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNNoUserIOTagSpecifies an input setting; that is, whether to prevent input typed by the user, but allows your application to use the TXNSetData function. Text objects could have read-only with respect to the application user, but have read-and-write privileges with respect to the application. If you pass this constant in the iControlTags parameter of the TXNSetTXNObjectControls function, you must also pass a value that specifies a read-write setting in the iControlData parameter. See Read and Write Privileges Settings for a description of possible values.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNUseCarbonEventsSpecifies settings for using Carbon events. (Deprecated. Use TXNGetEventTarget and TXNSetEventTarget.)
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNDrawCaretWhenInactiveTagSpecifies settings for drawing the caret when the text object does not have focus. (Deprecated. In Mac OS Xv10.4 and later, MLTE never draws the caret when the text object does not have focus.)
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNDrawSelectionWhenInactiveTagSpecifies settings for drawing the selection when the text object does not have focus.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNDisableDragAndDropTagSpecifies settings for drag and drop support.
Available in Mac OS X v10.1 and later.
Declared in MacTextEditor.h.
kTXNSingleLevelUndoTagSpecifies to use a single level of undo.
Available in Mac OS X v10.2 and later.
Declared in MacTextEditor.h.
kTXNVisibilityTagSpecifies visibility.
Available in Mac OS X v10.2 and later.
Declared in MacTextEditor.h.
kTXNDisableLayoutAndDrawTagSpecifies visibility. Equivalent to kTXNVisibilityTag. Available in Mac OS X v10.4 and later. Use this tag to disable and re-enable layout and drawing. It optimizes performance when adding data incrementally to a text object.
Available in Mac OS X v10.4 and later.
Declared in MacTextEditor.h.
kTXNAutoScrollBehaviorTagSpecifies autoscroll behavior. Available in Mac OS X v10.4 and later. For constants that represent the various types of autoscrolling, see Automatic Scrolling Behavior.
Available in Mac OS X v10.4 and later.
Declared in MacTextEditor.h.
You pass formatting and privileges settings in the iControlTags parameter of the TXNSetTXNObjectControls or TXNGetTXNObjectControls functions. If you want to clear a setting associated with a control tag, you can set the value of the iControlData parameter to Clearance Settings.
MacTextEditor.hSpecify frame options for a text object.
enum {
kTXNDrawGrowIconBit = 0,
kTXNShowWindowBit = 1,
kTXNWantHScrollBarBit = 2,
kTXNWantVScrollBarBit = 3,
kTXNNoTSMEverBit = 4,
kTXNReadOnlyBit = 5,
kTXNNoKeyboardSyncBit = 6,
kTXNNoSelectionBit = 7,
kTXNSaveStylesAsSTYLResourceBit = 8,
kOutputTextInUnicodeEncodingBit = 9,
kTXNDoNotInstallDragProcsBit = 10,
kTXNAlwaysWrapAtViewEdgeBit = 11,
kTXNDontDrawCaretWhenInactiveBit = 12,
kTXNDontDrawSelectionWhenInactiveBit = 13,
kTXNSingleLineOnlyBit = 14,
kTXNDisableDragAndDropBit = 15,
kTXNUseQDforImagingBit = 16,
kTXNMonostyledTextBit = 17
};
kTXNDrawGrowIconBitWhen this bit is set, it indicates the frame will have a size box. The presence of a size box in the lower right corner of an MLTE pane is only useful for resizing an MLTE pane if the MLTE pane occupies the entire window (a full-window MLTE object). In this case your application would look for a mouse-down event in the size box and call the function TXNGrowWindow as appropriate. Note that the size box is not supported as a means of resizing MLTE panes using TXNGrowWindow for MLTE pane objects.
Passing the kTXNDrawGrowIconMask constant to the function TXNNewObject only causes a size box to be drawn in the lower right corner of the MLTE pane. Passing this constant does not create a size box control in the window. The window will not contain an actual size box control. This means the window will not receive events that indicate a mouse-down event in the grow region. For this to happen, when you create the window that contains the MLTE pane, you must create the window to have a size box.
In summary, although you may pass the constants kTXNDrawGrowIconMask to the function TXNNewObject when you create an MLTE object in a window, this action only causes the visual appearance of a size box in the lower right corner of the MLTE pane. If you want to detect mouse-down events in the size box, you must also provide a size box in the window through the appropriate Window Manager functions or other tools.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNShowWindowBitWhen this bit is set, it indicates MLTE should display a window when a text object is created. If this bit is set, your application no longer needs to call the ShowWindow function from the Window Manager; MLTE will do this for you.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNWantHScrollBarBitWhen this bit is set, it indicates the frame should have a horizontal scroll bar.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNWantVScrollBarBitWhen this bit is set, it indicates the frame should have a vertical scroll bar.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNNoTSMEverBitWhen this bit is set, it indicates not to use Text Services Manager. You cannot use this bit when your application accepts Unicode input. (Deprecated. You can no longer set this because in Mac OS X, MLTE always uses the Text Services Manager.)
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNReadOnlyBitWhen this bit is set, it indicates the text object is read-only. If you set this bit when you call the function TXNNewObject, the text object is put into a state that does not allow user input. However, your application can put data into the text object by calling the function TXNSetData. If you want the text object set into a more restrictive read-only state that does not allow user input or your application to put data into the text object programmatically you need to call the function TXNSetTXNObjectControls, passing the tag kTXNIOPrivilegesTag.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNNoKeyboardSyncBitWhen this bit is set, it indicates no keyboard synchronization.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNNoSelectionBitWhen this bit is set, it indicates MLTE should not show the insertion point.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNSaveStylesAsSTYLResourceBitWhen this bit is set, it indicates text style should be saved as a kTXNMultipleStylesPerTextDocumentResType resource. You can set this to assure compatibility with SimpleText. If you use kTXNMultipleStylesPerTextDocumentResType resources to save style info, your documents can have as many styles as you’d like. However tabs are not saved. If you don’t set this bit, plain text files are saved as kTXNSingleStylePerTextDocumentResType resources, and only the first style in the document is saved. (Your application is expected to apply all style changes to the entire document.) If you save files with a kTXNSingleStylePerTextDocumentResType resource, their output is similar to those output by CodeWarrior, BBEdit, and MPW.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kOutputTextInUnicodeEncodingBitWhen this bit is set, it indicates plain text should be saved as Unicode.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNDoNotInstallDragProcsBitWhen this bit is set, it indicates you want to call your own drag handlers.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNAlwaysWrapAtViewEdgeBitWhen this bit is set, it indicates line wrap at the edge of the view rectangle.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNDontDrawCaretWhenInactiveBitWhen this bit is set, it indicates the caret should not be drawn when the object does not have focus. (Deprecated. In Mac OS X v10.4, MLTE never draws the caret when the text object does not have focus.)
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNDontDrawSelectionWhenInactiveBitWhen this bit is set, it indicates the selection should not be drawn when the object does not have focus.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNSingleLineOnlyBitWhen this bit is set, it indicates that the text object will not scroll vertically. Horizontal scrolling will stop when the end of the text is visible, and there will be no limit to the width of the text. In addition, a line break character typed, pasted, or dropped into the text object will be translated into a hyphen (-).
Available in Mac OS X v10.1 and later.
Declared in MacTextEditor.h.
kTXNDisableDragAndDropBitWhen this bit is set, it indicates that drag and drop will not be allowed in the text object.
Available in Mac OS X v10.1 and later.
Declared in MacTextEditor.h.
kTXNUseQDforImagingBitWhen this bit is set, it indicates that QuickDraw will be used for imaging instead of Quartz, which is the default. Available in Mac OS X only. (Deprecated. You can no longer set the imaging system to use; MLTE always uses Quartz imaging.)
Available in Mac OS X v10.1 and later.
Declared in MacTextEditor.h.
kTXNMonostyledTextBitWhen this bit is set, it indicates that the text object will have a single style no matter what kind of changes are made to the object.
Available in Mac OS X v10.2 and later.
Declared in MacTextEditor.h.
MacTextEditor.hRepresents information about frame behavior (such as whether there are scroll bars and a size box).
typedef OptionBits TXNFrameOptions; enum { kTXNDrawGrowIconMask = 1L << kTXNDrawGrowIconBit, kTXNShowWindowMask = 1L << kTXNShowWindowBit, kTXNWantHScrollBarMask = 1L << kTXNWantHScrollBarBit, kTXNWantVScrollBarMask = 1L << kTXNWantVScrollBarBit, kTXNNoTSMEverMask = 1L << kTXNNoTSMEverBit, kTXNReadOnlyMask = 1L << kTXNReadOnlyBit, kTXNNoKeyboardSyncMask = 1L << kTXNNoKeyboardSyncBit, kTXNNoSelectionMask = 1L << kTXNNoSelectionBit, kTXNSaveStylesAsSTYLResourceMask = 1L << kTXNSaveStylesAsSTYLResourceBit, kOutputTextInUnicodeEncodingMask = 1L << kOutputTextInUnicodeEncodingBit, kTXNDoNotInstallDragProcsMask = 1L << kTXNDoNotInstallDragProcsBit, kTXNAlwaysWrapAtViewEdgeMask = 1L << kTXNAlwaysWrapAtViewEdgeBit, kTXNDontDrawCaretWhenInactiveMask = 1L << kTXNDontDrawCaretWhenInactiveBit, kTXNDontDrawSelectionWhenInactiveMask = 1L << kTXNDontDrawSelectionWhenInactiveBit, kTXNSingleLineOnlyMask = 1L << kTXNSingleLineOnlyBit, kTXNDisableDragAndDropMask = 1L << kTXNDisableDragAndDropBit, kTXNUseQDforImagingMask = 1L << kTXNUseQDforImagingBit, kTXNMonostyledTextMask = 1L << kTXNMonostyledTextBit };
kTXNDrawGrowIconMaskUse to set or test for the kTXNDrawGrowIconBit bit.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNShowWindowMaskUse to set or test for the kTXNShowWindowBit bit.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNWantHScrollBarMaskUse to set or test for the kTXNWantHScrollBarBit bit.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNWantVScrollBarMask Use to set or test for the kTXNWantVScrollBarBit bit.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNNoTSMEverMaskUse to set or test for the kTXNNoTSMEverBit bit. (Deprecated. You can no longer set this because in Mac OS X, MLTE always uses the Text Services Manager.)
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNReadOnlyMaskUse to set or test for the kTXNReadOnlyBit bit.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNNoKeyboardSyncMaskUse to set or test for the kTXNNoKeyboardSyncBit bit.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNNoSelectionMaskUse to set or test for the kTXNNoSelectionBit bit.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNSaveStylesAsSTYLResourceMaskUse to set or test for the kTXNSaveStylesAsSTYLResourceBit bit.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kOutputTextInUnicodeEncodingMaskUse to set or test for the kOutputTextInUnicodeEncodingBit bit.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNDoNotInstallDragProcsMaskUse to set or test for the kTXNDoNotInstallDragProcsBit bit.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNAlwaysWrapAtViewEdgeMaskUse to set or test for the kTXNAlwaysWrapAtViewEdgeBit bit.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNDontDrawCaretWhenInactiveMaskUse to set or test for the kTXNDontDrawCaretWhenInactiveBit bit. (Deprecated. In Mac OS Xv10.4 and later, MLTE never draws the caret when the text object does not have focus.)
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNDontDrawSelectionWhenInactiveMaskUse to set or test for the kTXNDontDrawSelectionWhenInactiveBit bit.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNSingleLineOnlyMaskUse to set or test for the kTXNSingleLineOnlyBit bit.
Available in Mac OS X v10.1 and later.
Declared in MacTextEditor.h.
kTXNDisableDragAndDropMaskUse to set or test for the kTXNDisableDragAndDropBit bit.
Available in Mac OS X v10.1 and later.
Declared in MacTextEditor.h.
kTXNUseQDforImagingMaskUse to set or test for the kTXNUseQDforImagingBit bit. (Deprecated. You can no longer set the imaging system; MLTE always uses Quartz imaging.)
Available in Mac OS X v10.1 and later.
Declared in MacTextEditor.h.
kTXNMonostyledTextMaskUse to set or test for the kTXNMonostyledTextBit bit.
Available in Mac OS X v10.2 and later.
Declared in MacTextEditor.h.
See Frame Option Bits.
MacTextEditor.hSpecifies the HIObject class ID for the HITextView class.
#define kHITextViewClassID CFSTR("com.apple.HITextView")
For more information on HIView, see the document Introducing HIView, available from the Apple Developer Documentation website.
MacTextEditor.hSpecifies the HIObject control kind for the HITextView class.
enum {
kControlKindHITextView = 'hitx'
};
kControlKindHITextViewThe control kind for the HITextView class.
Available in Mac OS X v10.3 and later.
Declared in HITextViews.h.
For more information on HIView, see the document Introducing HIView, available from the Apple Developer Documentation website.
MacTextEditor.hSpecify initialization options for MLTE.
enum {
kTXNWantMoviesBit = 0,
kTXNWantSoundBit = 1,
kTXNWantGraphicsBit = 2,
kTXNAlwaysUseQuickDrawTextBit = 3,
kTXNUseTemporaryMemoryBit = 4
};
kTXNWantMoviesBitWhen this bit is set, it specifies that movie data is supported in a text object.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNWantSoundBitWhen this bit is set, it specifies that sound data is supported in a text object.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNWantGraphicsBitWhen this bit is set, it specifies that graphics data is supported in a text object.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNAlwaysUseQuickDrawTextBitWhen this bit is set, it specifies that MLTE should use QuickDraw for imaging even if ATSUI is available. This is often the best choice for applications that need speed and efficient memory usage.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNUseTemporaryMemoryBitWhen this bit is set, it specifies that MLTE should use temporary memory for all memory allocations.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
MacTextEditor.hRepresents MLTE initialization options.
typedef OptionBits TXNInitOptions; enum { kTXNWantMoviesMask = 1L << kTXNWantMoviesBit, kTXNWantSoundMask = 1L << kTXNWantSoundBit, kTXNWantGraphicsMask = 1L << kTXNWantGraphicsBit, kTXNAlwaysUseQuickDrawTextMask = 1L << kTXNAlwaysUseQuickDrawTextBit, kTXNUseTemporaryMemoryMask = 1L << kTXNUseTemporaryMemoryBit };
kTXNWantMoviesMaskUse to set or test for the kTXNWantMoviesBit bit.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNWantSoundMaskUse to set or test for the kTXNWantSoundBit bit.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNWantGraphicsMaskUse to set or test for the kTXNWantGraphicsBit bit.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNAlwaysUseQuickDrawTextMaskUse to set or test for the kTXNAlwaysUseQuickDrawTextBit bit.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNUseTemporaryMemoryMaskUse to set or test for the kTXNUseTemporaryMemoryBit bit.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
Used in the iUsageFlags parameter of the TXNInitTextension function.
MacTextEditor.hSpecify the inline state for a text object.
enum {
kTXNUseInline = false,
kTXNUseBottomline = true
};
kTXNUseInlineText is entered at the caret insertion point in the text object’s window.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNUseBottomlineText is entered in a bottom-line window (a small floating window that appears at the bottom of the screen).
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
Passed in the iControlData parameter of the TXNSetTXNObjectControls function when the value of the iControlTags parameter is kTXNInlineStateTag, or returned in the oControlData parameter of the TXNGetTXNObjectControls function when the value of the iControlTags parameter is kTXNInlineStateTag.
MacTextEditor.hSpecify the justification setting.
enum {
kTXNFlushDefault = 0,
kTXNFlushLeft = 1,
kTXNFlushRight = 2,
kTXNCenter = 4,
kTXNFullJust = 8,
kTXNForceFullJust = 16
};
kTXNFlushDefaultJustification is flush according to the line direction.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNFlushLeftJustification is flush left.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNFlushRightJustification is flush right.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNCenterJustification is centered.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNFullJustJustification is flush left and right for all lines except the last line in a paragraph.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNForceFullJustJustification is flush left and right for all lines.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
Passed in the iControlData parameter of the TXNSetTXNObjectControls function when the value of the iControlTags parameter is kTXNJustificationTag, or returned in the oControlData parameter of the TXNGetTXNObjectControls function when the value of the iControlTags parameter is kTXNJustificationTag.
MacTextEditor.hSpecify the keyboard synchronization setting for a text object.
enum {
kTXNSyncKeyboard = false,
kTXNNoSyncKeyboard = true
};
kTXNSyncKeyboardKeyboard synchronization is enabled.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNNoSyncKeyboardKeyboard synchronization is not enabled.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
These constants are passed in the iControlData parameter of the TXNSetTXNObjectControls function when the value of the iControlTags parameter is kTXNKeyboardSyncStateTag. They are also returned in the oControlData parameter of the TXNGetTXNObjectControls function when the value of the iControlTags parameter is kTXNKeyboardSyncStateTag.
MacTextEditor.hSpecify the layout and draw setting for a text object.
enum {
kTXNEnableLayoutAndDraw = false,
kTXNDisableLayoutAndDraw = true
};
kTXNEnableLayoutAndDrawLayout and draw is enabled.
Available in Mac OS X v10.4 and later.
Declared in MacTextEditor.h.
kTXNDisableLayoutAndDrawLayout and draw is disabled.
Available in Mac OS X v10.4 and later.
Declared in MacTextEditor.h.
These constants are passed in the iControlData parameter of the TXNSetTXNObjectControls function when the value of the iControlTags parameter is kTXNDisableLayoutAndDrawTag. They are also are returned in the oControlData parameter of the TXNGetTXNObjectControls function when the value of the iControlTags parameter is kTXNDisableLayoutAndDrawTag.
MacTextEditor.hSpecify the line direction setting.
enum {
kTXNLeftToRight = 0,
kTXNRightToLeft = 1
};
kTXNLeftToRightLine direction flows from left to right.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNRightToLeftLine direction flows from right to left.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
Passed in the iControlData parameter of the TXNSetTXNObjectControls function when the value of the iControlTags parameter is kTXNLineDirectionTag, or returned in the oControlData parameter of the TXNGetTXNObjectControls function when the value of the iControlTags parameter is kTXNLineDirectionTag.
MacTextEditor.hSpecify the line-wrap setting for a text object.
enum {
kTXNAutoWrap = false,
kTXNNoAutoWrap = true
};
kTXNAutoWrapAutomatic line wrapping is enabled.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNNoAutoWrapAutomatic line wrapping is not enabled.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
Passed in the iControlData parameter of the TXNSetTXNObjectControls function when the value of the iControlTags parameter is kTXNWordWrapStateTag, or returned in the oControlData parameter of the TXNGetTXNObjectControls function when the value of the iControlTags parameter is kTXNWordWrapStateTag.
MacTextEditor.hSpecify the privileges setting for a text object.
enum {
kTXNReadWrite = false,
kTXNReadOnly = true
};
kTXNReadWriteThe document has read and write privileges.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNReadOnlyThe document is read-only.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
Passed in the iControlData parameter of the TXNSetTXNObjectControls function when the value of the iControlTags parameter is kTXNIOPrivilegesTag, or returned in the oControlData parameter of the TXNGetTXNObjectControls function when the value of the iControlTags parameter is kTXNIOPrivilegesTag.
MacTextEditor.hSpecifies the bounds to use for a text object.
typedef UInt32 TXNRectKey;
enum {
kTXNViewRectKey = 0,
kTXNDestinationRectKey = 1,
kTXNTextRectKey = 2,
kTXNVerticalScrollBarRectKey = 3,
kTXNHorizontalScrollBarRectKey = 4
};
kTXNViewRectKeySpecifies to use the view rectangle.
Available in Mac OS X v10.3 and later.
Declared in MacTextEditor.h.
kTXNDestinationRectKeySpecifies to use the destination rectangle.
Available in Mac OS X v10.3 and later.
Declared in MacTextEditor.h.
kTXNTextRectKeySpecifies to use the text rectangle.
Available in Mac OS X v10.3 and later.
Declared in MacTextEditor.h.
kTXNVerticalScrollBarRectKeySpecifies to include the vertical scroll bar in the rectangle.
Available in Mac OS X v10.3 and later.
Declared in MacTextEditor.h.
kTXNHorizontalScrollBarRectKeySpecifies to include the horizontal scroll bar in the rectangle.
Available in Mac OS X v10.3 and later.
Declared in MacTextEditor.h.
You can pass a rectangle key to the function TXNGetHIRect.
MacTextEditor.hSpecifies the orientation of a text window’s scroll bar.
typedef UInt32 TXNScrollBarOrientation;
enum {
kTXNHorizontal = 0,
kTXNVertical = 1
};
kTXNHorizontalSpecifies a horizontal scroll bar.
Available in Mac OS X v10.2 and later.
Declared in MacTextEditor.h.
kTXNVerticalSpecifies a vertical scroll bar.
Available in Mac OS X v10.2 and later.
Declared in MacTextEditor.h.
You use these constants in your TXNScrollInfoProcPtr callback function.
MacTextEditor.hRepresents the scroll bar state for the window attached to a text object.
typedef Boolean TXNScrollBarState;
enum {
kScrollBarsAlwaysActive = true,
kScrollBarsSyncWithFocus = false
};
kScrollBarsAlwaysActiveIndicates that scroll bars should always appear in the active state even then the text area does not have focus.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kScrollBarsSyncWithFocusIndicates that scroll bars should be active only if the frame in which they are enclosed is focused.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
Used in the TXNActivate function.
MacTextEditor.hSpecify the unit by which scrolling should occur.
typedef UInt32 TXNScrollUnit;
enum {
kTXNScrollUnitsInPixels = 0,
kTXNScrollUnitsInLines = 1,
kTXNScrollUnitsInViewRects = 2
};
kTXNScrollUnitsInPixelsSpecifies pixels as the scrolling unit.
Available in Mac OS X v10.2 and later.
Declared in MacTextEditor.h.
kTXNScrollUnitsInLinesSpecifies line count as the scrolling unit. Scrolling is slower when you use this unit because each line must be measured by MLTE before the text scrolls.
Available in Mac OS X v10.2 and later.
Declared in MacTextEditor.h.
kTXNScrollUnitsInViewRectsSpecifies the height of the current view rectangle as the scrolling unit.
Available in Mac OS X v10.2 and later.
Declared in MacTextEditor.h.
These constants are supplied as the iVerticalScrollUnit and iHorizontalScrollUnit parameters to the TXNScroll function. They specifies the units used for each of these parameters.
MacTextEditor.hSpecify matching rules to use when searching.
enum {
kTXNIgnoreCaseBit = 0,
kTXNEntireWordBit = 1,
kTXNUseEncodingWordRulesBit = 31
};
kTXNIgnoreCaseBitWhen this bit is set, indicates that case should be ignored.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNEntireWordBitWhen this bit is set, indicates that the entire word must match.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNUseEncodingWordRulesBitWhen this bit is set, indicates that Unicode Utilities should be used to find a word boundary. You need to set this bit if your applications uses 2-byte scripts in which words are not separated by a space.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
MacTextEditor.hRepresents the matching rules to be used in a find operation.
typedef OptionBits TXNMatchOptions; enum { kTXNIgnoreCaseMask = 1L << kTXNIgnoreCaseBit, kTXNEntireWordMask = 1L << kTXNEntireWordBit, kTXNUseEncodingWordRulesMask = 1L << kTXNUseEncodingWordRulesBit };
kTXNIgnoreCaseMaskUse to set or test for the kTXNIgnoreCaseBit bit.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNEntireWordMaskUse to set or test for the kTXNEntireWordBit bit.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNUseEncodingWordRulesMaskUse to set or test for the kTXNEntireWordBit bit.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
These constants can be passed in the iMatchOptions parameter of the TXNFind function or the callback TXNFindProcPtr.
MacTextEditor.hSpecify whether the text object should scroll to show the beginning or the end of the selection.
enum {
kTXNShowStart = false,
kTXNShowEnd = true
};
kTXNShowStartThe start of the selection should be shown. The selection scrolls to show the start if necessary.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNShowEndThe end of the selection should be shown. The selection scrolls to show the end if necessary.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
MacTextEditor.hSpecify whether or not MLTE displays a caret and allows selections in text that is read-only.
enum {
kTXNSelectionOn = true,
kTXNSelectionOff = false
};
kTXNSelectionOnDisplay a caret and allow a selection in text that is read-only.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNSelectionOffDo not display a caret or allow a selection in text that is read-only.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
Passed in the iControlData parameter of the TXNSetTXNObjectControls function when the value of the iControlTags parameter is kTXNSelectionStateTag, or returned in the oControlData parameter of the TXNGetTXNObjectControls function when the value of the iControlTags parameter is kTXNSelectionStateTag.
MacTextEditor.hSpecify the resource type to use to save style information for a plain text document.
enum {
kTXNSingleStylePerTextDocumentResType = 'MPSR',
kTXNMultipleStylesPerTextDocumentResType = 'styl'
};
kTXNSingleStylePerTextDocumentResTypeUser for a document that contains a single style and should be treated as a BBEdit, MPW, or CodeWarrior document.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNMultipleStylesPerTextDocumentResTypeUse for a document that contains multiple styles and should be treated as a SimpleText document.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
Used in the TXNNewObject function.
MacTextEditor.hSpecifies the type of data being requested from or passed to an MLTE function.
typedef OSType TXNDataType;
enum {
kTXNTextData = 'TEXT',
kTXNPictureData = 'PICT',
kTXNMovieData = 'moov',
kTXNSoundData = 'snd ',
kTXNUnicodeTextData = 'utxt'
};
kTXNTextDataText data.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNPictureDataGraphics (PICT) data.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNMovieDataMovie or sound data.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNSoundDataSound data.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNUnicodeTextDataUnicode text data.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
Used in the TXNGetDataEncoded function.
MacTextEditor.hRepresents a file type.
typedef OSType TXNFileType;
enum {
kTXNTextensionFile = 'txtn',
kTXNTextFile = 'TEXT',
kTXNPictureFile = 'PICT',
kTXNMovieFile = 'MooV',
kTXNSoundFile = 'sfil',
kTXNAIFFFile = 'AIFF',
kTXNUnicodeTextFile = 'utxt'
};
kTXNTextensionFileA file that contains Unicode or Mac OS text. By default, it contains Unicode text. Files are saved in a private format.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNTextFileA file that contains plain text data.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNPictureFileA file that contains graphics data in PICT format.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNMovieFileA file that contains movie data in 'MooV' format.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNSoundFileA file that contains sound data in 'sfil' format.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNAIFFFileA file that contains sound data in 'aiff' format.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNUnicodeTextFileA file that contains Unicode text data.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
MacTextEditor.hRepresents a frame type. (Deprecated. No longer needed.)
typedef UInt32 TXNFrameType;
enum {
kTXNTextEditStyleFrameType = 1,
kTXNPageFrameType = 2,
kTXNMultipleFrameType = 3
};
kTXNTextEditStyleFrameTypeA single rectangle that allows text to scroll if the rectangle fills. Although you can pass this as a parameter to the function TXNNewObject, you should instead use the function TXNCreateObject, which does not require a frame type.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNPageFrameTypeA single rectangle with a bottom. That is, text moves to a new page if the frame is full. This constant is not supported in Mac OS X version 10.3 and later.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNMultipleFrameTypeMultiple frames. This constant is not supported in Mac OS X version 10.3 and later.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
This data type is used only by the TXNNewObject function, which is deprecated.
MacTextEditor.hDefines the tab settings for a text object.
typedef SInt8 TXNTabType;
enum {
kTXNRightTab = -1,
kTXNLeftTab = 0,
kTXNCenterTab = 1
};
kTXNRightTabRight tabs are active.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNLeftTabLeft tabs are active; not available in MLTE version 1.0.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNCenterTabCenter tabs are active; not available in MLTE version 1.0.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
Used in the TXNTab structure.
MacTextEditor.hRepresents a background data type used in the TXNBackground structure.
typedef UInt32 TXNBackgroundType;
enum {
kTXNBackgroundTypeRGB = 1
};
kTXNBackgroundTypeRGBIndicates color.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
Used in the TXNBackground structure. MLTE supports only color as the background type.
MacTextEditor.hSpecify how text should be displayed in a Unicode text box.
enum {
kTXNSetFlushnessBit = 0,
kTXNSetJustificationBit = 1,
kTXNUseFontFallBackBit = 2,
kTXNRotateTextBit = 3,
kTXNUseVerticalTextBit = 4,
kTXNDontUpdateBoxRectBit = 5,
kTXNDontDrawTextBit = 6,
kTXNUseCGContextRefBit = 7,
kTXNImageWithQDBit = 8,
kTXNDontWrapTextBit = 9
};
kTXNSetFlushnessBitWhen this bit is set, indicates MLTE should display text flush according to the line direction.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNSetJustificationBitWhen this bit is set, indicates justification. Text is justified in the direction of the display. Horizontal text is justified horizontally, but not vertically. Vertical text is justified vertically, but not horizontally.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNUseFontFallBackBitWhen this bit is set, indicates MLTE should use ATSUI transient font matching that searches for a font that has a matching character.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNRotateTextBitWhen this bit is set, indicates MLTE should display text rotated clockwise.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNUseVerticalTextBitWhen this bit is set, indicates MLTE should display text vertically from top to bottom.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNDontUpdateBoxRectBitWhen this bit is set, indicates MLTE should not update the specified rectangle. If you set this bit when you call the TXNDrawUnicodeTextBox function, the function does not update the right coordinates of the specified rectangle to accommodate the longest line for text.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNDontDrawTextBitWhen this bit is set, indicates MLTE should return the size of the text but should not draw the text box.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNUseCGContextRefBitWhen this bit is set, indicates MLTE should the Quartz context (CGContext) you provide instead of the temporary CGContextRef created internally by MLTE. To do so, you must set the kTXNUseCGContextRefBit bit in TXNTextBoxOptions and pass a CGContextRef in the options field of the TXNTextBoxOptionsData structure.
Available in Mac OS X v10.1 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNImageWithQDBitWhen this bit is set, indicates MLTE should use QuickDraw for imaging text. (Deprecated. You can no longer set the imaging system; MLTE always uses Quartz imaging.)
Available in Mac OS X v10.1 and later.
Declared in MacTextEditor.h.
kTXNDontWrapTextBitWhen this bit is set, indicates MLTE should not wrap text.
Available in Mac OS X v10.1 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
MacTextEditor.hDefines how text appears in a text box.
typedef OptionBits TXNTextBoxOptions; enum { kTXNSetFlushnessMask = 1L << kTXNSetFlushnessBit, kTXNSetJustificationMask = 1L << kTXNSetJustificationBit, kTXNUseFontFallBackMask = 1L << kTXNUseFontFallBackBit, kTXNRotateTextMask = 1L << kTXNRotateTextBit, kTXNUseVerticalTextMask = 1L << kTXNUseVerticalTextBit, kTXNDontUpdateBoxRectMask = 1L << kTXNDontUpdateBoxRectBit, kTXNDontDrawTextMask = 1L << kTXNDontDrawTextBit, kTXNUseCGContextRefMask = 1L << kTXNUseCGContextRefBit, kTXNImageWithQDMask = 1L << kTXNImageWithQDBit, kTXNDontWrapTextMask = 1L << kTXNDontWrapTextBit };
kTXNSetFlushnessMaskUse to set or test for the kTXNSetFlushnessBit bit.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNSetJustificationMaskUse to set or test for the kTXNSetJustificationBit bit.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNUseFontFallBackMaskUse to set or test for the kTXNUseFontFallBackBit bit.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNRotateTextMaskUse to set or test for the kTXNRotateTextBit bit.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNUseVerticalTextMaskUse to set or test for the kTXNUseVerticalTextBit bit.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNDontUpdateBoxRectMaskUse to set or test for the kTXNDontUpdateBoxRectBit bit.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNDontDrawTextMaskUse to set or test for the kTXNDontDrawTextBit bit.
Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNUseCGContextRefMaskUse to set or test for kTXNUseCGContextRefBit bit.
Available in Mac OS X v10.1 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
kTXNImageWithQDMaskUse to set or test for kTXNImageWithQDBit bit. (Deprecated. You can no longer set the imaging system; MLTE always uses Quartz imaging.)
Available in Mac OS X v10.1 and later.
Declared in MacTextEditor.h.
kTXNDontWrapTextMaskUse to set or test for kTXNDontWrapTextBit bit.
Available in Mac OS X v10.1 and later.
Not available to 64-bit applications.
Declared in MacTextEditor.h.
Used in the TXNDrawUnicodeTextBox and TXNDrawCFStringTextBox functions.
MacTextEditor.hRepresents how to encode text for your application.
typedef UInt32 TXNPermanentTextEncodingType;
enum {
kTXNSystemDefaultEncoding = 0,
kTXNMacOSEncoding = 1,
kTXNUnicodeEncoding = 2
};
kTXNSystemDefaultEncodingUse the encoding that is used internally by MLTE and the system. The preferred encoding is Unicode for a system that has ATSUI.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNMacOSEncodingIncoming and outgoing text should be in traditional Mac OS script system encodings even if MLTE uses another format internally. MLTE will use the Text Encoding Convertor (TEC) to convert text and offsets to match your application’s preference.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
kTXNUnicodeEncodingIncoming and outgoing text should be in Unicode even on systems that do not have ATSUI. MLTE will use the Text Encoding Convertor (TEC) to convert text and offsets to match the applications preference.
Available in Mac OS X v10.0 and later.
Declared in MacTextEditor.h.
These convenience constants can be used in the functions TXNNewObject and TXNSave.
MacTextEditor.hThe most common result codes returned by MLTE are listed below.
| Result Code | Value | Description |
|---|---|---|
kTXNEndIterationErr |
-22000 | Function was not able to iterate through the data contained by a text object. Available in Mac OS X v10.0 and later. |
kTXNCannotAddFrameErr |
-22001 | Frame was not added. The multiple-frame feature is currently not available in MLTE, so this error is returned any time you try to define an object with multiple frames. Available in Mac OS X v10.0 and later. |
kTXNInvalidFrameIDErr |
-22002 | The frame ID is invalid. Available in Mac OS X v10.0 and later. |
kTXNIllegalToCrossDataBoundariesErr |
-22003 | Offsets specify a range that crosses a data type boundary. Available in Mac OS X v10.0 and later. |
kTXNUserCanceledOperationErr |
-22004 | A user canceled an operation before your application completed processing it. Available in Mac OS X v10.0 and later. |
kTXNBadDefaultFileTypeWarning |
-22005 | Text file is not in the format you specified. Available in Mac OS X v10.0 and later. |
kTXNCannotSetAutoIndentErr |
-22006 | Automatic indenting could not be enabled—the document has word wrapping enabled and you tried to enable auto indentation. Available in Mac OS X v10.0 and later. |
kTXNRunIndexOutofBoundsErr |
-22007 | An index you supplied to a function is out of bounds. Available in Mac OS X v10.0 and later. |
kTXNNoMatchErr |
-22008 | Returned by Available in Mac OS X v10.0 and later. |
kTXNAttributeTagInvalidForRunErr |
-22009 | Tag for a specific run is not valid. Available in Mac OS X v10.0 and later. |
kTXNSomeOrAllTagsInvalidForRunErr |
-22010 | Tags supplied to a function are not valid. Available in Mac OS X v10.0 and later. |
kTXNInvalidRunIndex |
-22011 | Index is out of range for that run. Available in Mac OS X v10.0 and later. |
kTXNAlreadyInitializedErr |
-22012 | You already called the Available in Mac OS X v10.0 and later. |
kTXNCannotTurnTSMOffWhenUsingUnicodeErr |
-22013 | Your application tried to turn off the Text Services Manager while MLTE was set to process Unicode. Available in Mac OS X v10.0 and later. |
kTXNCopyNotAllowedInEchoModeErr |
-22014 | Your application tried to copy text that was in echo mode. Available in Mac OS X v10.0 and later. |
kTXNDataTypeNotAllowedErr |
-22015 | Your applications specifies a data type that MTLE does not allow. Available in Mac OS X v10.0 and later. |
kTXNATSUIIsNotInstalledErr |
-22016 | Indicates ATSUI is not installed on the system. Available in Mac OS X v10.0 and later. |
kTXNOutsideOfLineErr |
-22017 | Indicates a value that is beyond the length of the line. Available in Mac OS X v10.0 and later. |
kTXNOutsideOfFrameErr |
-22018 | Indicates a value that is outside of the text object’s frame. Available in Mac OS X v10.0 and later. |
kTXNDisabledFunctionalityErr |
-22019 | Indicates the function has been disabled. Available in Mac OS X v10.3 and later. |
kTXNOperationNotAllowedErr |
-22020 | Indicates that the function cannot be called in this context. Available in Mac OS X v10.4 and later. |
Last updated: 2008-09-29
