# Functions

DPSOperators functions

ctxt
fmt
Description forthcoming.
ctxt
buf
count
Description forthcoming.
ctxt
x
y
r
angle1
angle2
Description forthcoming.
ctxt
x
y
r
angle1
angle2
Description forthcoming.
ctxt
x1
y1
x2
y2
r
Description forthcoming.
ctxt
x
y
s
Description forthcoming.
ctxt
cx
cy
c
ax
ay
s
Description forthcoming.
ctxt
s
b
Description forthcoming.
ctxt
Description forthcoming.
ctxt
Description forthcoming.
ctxt
x
y
w
h
gstateNum
dx
dy
op
Description forthcoming.
ctxt
x
y
w
h
op
Description forthcoming.
ctxt
m
Description forthcoming.
ctxt
a
Description forthcoming.
ctxt
c
m
y
k
Description forthcoming.
ctxt
flatness
Description forthcoming.
ctxt
gray
Description forthcoming.
ctxt
h
s
b
Description forthcoming.
ctxt
linecap
Description forthcoming.
ctxt
linejoin
Description forthcoming.
ctxt
width
Description forthcoming.
ctxt
limit
Description forthcoming.
ctxt
x
y
Description forthcoming.
ctxt
x
y
Description forthcoming.
ctxt
r
g
b
Description forthcoming.
ctxt
b
Description forthcoming.
ctxt
x1
y1
x2
y2
x3
y3
Description forthcoming.
ctxt
x
y
w
h
gstateNum
dx
dy
delta
Description forthcoming.
ctxt
Description forthcoming.
ctxt
Description forthcoming.
ctxt
Description forthcoming.
ctxt
Description forthcoming.
ctxt
Description forthcoming.
ctxt
Description forthcoming.
ctxt
Description forthcoming.
ctxt
Description forthcoming.
ctxt
Description forthcoming.
ctxt
x
y
Description forthcoming.
ctxt
x
y
Description forthcoming.
ctxt
Description forthcoming.
ctxt
llx
lly
urx
ury
Description forthcoming.
ctxt
x1
y1
x2
y2
x3
y3
Description forthcoming.
ctxt
x
y
w
h
Description forthcoming.
ctxt
x
y
w
h
Description forthcoming.
ctxt
x
y
w
h
Description forthcoming.
ctxt
Description forthcoming.
ctxt
x
y
Description forthcoming.
ctxt
x
y
Description forthcoming.
ctxt
angle
Description forthcoming.
ctxt
x
y
Description forthcoming.
ctxt
a
Description forthcoming.
ctxt
c
m
y
k
Description forthcoming.
ctxt
pat
size
offset
Description forthcoming.
ctxt
flatness
Description forthcoming.
ctxt
gray
Description forthcoming.
ctxt
gst
Description forthcoming.
ctxt
x
y
Description forthcoming.
ctxt
h
s
b
Description forthcoming.
ctxt
linecap
Description forthcoming.
ctxt
linejoin
Description forthcoming.
ctxt
width
Description forthcoming.
ctxt
limit
Description forthcoming.
ctxt
x
y
Description forthcoming.
ctxt
r
g
b
Description forthcoming.
ctxt
b
Description forthcoming.
ctxt
shaderDictionary
Description forthcoming.
ctxt
s
Description forthcoming.
ctxt
Description forthcoming.
ctxt
x
y
Description forthcoming.
ctxt
x
y
c
s
Description forthcoming.
ctxt
s
numarray
size
Description forthcoming.
ctxt
s
numarray
size
Description forthcoming.
ctxt
s
numarray
size
Description forthcoming.
ctxt
ctm
Description forthcoming.
ctxt
Description forthcoming.
ctxt
device
x
y
Description forthcoming.
ctxt
Description forthcoming.
ctxt
rect
imageref
Description forthcoming.
ctxt
Description forthcoming.
ctxt
Description forthcoming.
ctxt
rects
count
Description forthcoming.
ctxt
rects
count
Description forthcoming.
ctxt
gst
Description forthcoming.
ctxt
path
Description forthcoming.
ctxt
ctm
Description forthcoming.
ctxt
extra
Description forthcoming.
ctxt
device
x
y
Description forthcoming.
ctxt
values
Description forthcoming.
ctxt
dict
Description forthcoming.
ctxt
font
Description forthcoming.
ctxt
size
Description forthcoming.
ctxt
values
Description forthcoming.
ctxt
dict
Description forthcoming.
ctxt
ctm
Description forthcoming.
ctxt
mode
Description forthcoming.
ctxt
loc
Description forthcoming.
ctxt
glyphs
length
Description forthcoming.
ctxt
glyphs
advances
length
Description forthcoming.
ctxt
string
length
Description forthcoming.
ctxt
gst
Description forthcoming.
NSAccessibilityConstants functions

element
notification
userInfo
Description forthcoming.
NSAccessibility functions

action
Description forthcoming.
element
notification
Description forthcoming.
role
subrole
Description forthcoming.
element
Description forthcoming.
element
Description forthcoming.
originalChildren
Description forthcoming.
originalChild
Description forthcoming.
element
Description forthcoming.
NSApplication functions

appName
port
expire

Establishes an NSConnection to the application listening at port (by convention usually the application name), launching appName if necessary. Returns the proxy to the remote application, or `nil` on failure.

The value of port specifies the name of the distributed objects service to which the connection is to be made. If this is `nil` it will be inferred from appName... by convention, applications use their own name (minus any path or extension) for this.

If appName is `nil` or cannot be launched, this attempts to locate any application in a standard location whose name matches port and launch that application.

The value of expire provides a timeout in case the application cannot be contacted promptly. If it is omitted, a thirty second timeout is used.

argc
argv
Description forthcoming.
serviceItem
pboard

Given the name of a serviceItem, and some data in a pasteboard this function sends the data to the service provider (launching another application if necessary) and retrieves the result of the service in the pastebaord.

Returns `YES` on success, `NO` otherwise.
provider
name
Registers a services providing object using the specified port name.
Applications should not need to use this, as they can use the [NSApplication -setServicesProvider:] method instead. The NSApplication method will use the name of the application rather than an other port name.
name
enabled

Controls whether the item name should be included in the services menu.

If enabled is `YES` then the services menu for each application will include the named item, if enabled is `NO` then the service will not be shown in application services menus.

Returns 0 if the setting is successfuly changed. Non-zero otherwise.

options
Description forthcoming.
name
Returns a flag indicating whether the named service is supposed to be displayed in application services menus.
name
Description forthcoming.
A services providing application may use this to update the list of services it provides.
In order to update the services advertised, the application must create a .service bundle and place it in `~/Library/Services` before invoking this function.
NSDataLinkManager functions

aRect
isDestination
Description forthcoming.
Description forthcoming.
NSEvent functions

type
Description forthcoming.
NSFont functions

glBuf
count
packing
packedGlyphs
Description forthcoming.
NSGraphicsContext functions

Description forthcoming.
NSGraphics functions

Description forthcoming.
Description forthcoming.
ctxt
flipped
Description forthcoming.
ctxt
Description forthcoming.
num
Description forthcoming.
Description forthcoming.
Description forthcoming.
colorSpace
bitsPerSample
bitsPerPixel
planar
exactMatch
Description forthcoming.
depth
Description forthcoming.
depth
Description forthcoming.
depth
Description forthcoming.
globalNum
winNum
Description forthcoming.
winNum
globalNum
Description forthcoming.
srcGstate
srcRect
destRect
Description forthcoming.
srcGstate
srcRect
destPoint
Description forthcoming.
count
Description forthcoming.
context
count
Description forthcoming.
aRect
Draws a rectangle along the inside of aRect. The rectangle will be black, dotted (using 1 point dashes), and will have a line width of 1 point.
aRect
clipRect
Description forthcoming.
rect
pixelsWide
pixelsHigh
bitsPerSample
samplesPerPixel
bitsPerPixel
bytesPerRow
isPlanar
hasAlpha
colorSpaceName
data
Description forthcoming.
aRect
clipRect
Description forthcoming.
boundsRect
clipRect
sides
colors
count
Description forthcoming.
aRect
clipRect
Description forthcoming.
aRect
clipRect
Description forthcoming.
aRect
clipRect
Description forthcoming.
aRect
clipRect
Description forthcoming.
aRect
clipRect
Description forthcoming.
aRect
topLeft
topMiddle
topRight
centerLeft
centerMiddle
centerRight
bottomLeft
bottomMiddle
bottomRight
op
fraction
flipped
Description forthcoming.
aRect
start
middle
end
isVertical
op
fraction
flipped
Description forthcoming.
aRect
clipRect
sides
grays
count
Draws a set of edges of aRect. The sides array should contain count edges, and grays the corresponding color. Edges are drawn in the order given in the array, and subsequent edges are drawn inside previous edges (thus, they will never overlap).
aRect
clipRect
Description forthcoming.
aRect
Description forthcoming.
aRect
Description forthcoming.
aRect

Draws a rectangle using the current color along the inside of aRect. NSFrameRectWithWidth uses the frameWidth as the line width, while NSFrameRect always uses 1 point wide lines. The functions do not change the line width of the current graphics context.

'Inside' here means that no part of the stroked rectangle will extend outside the given rectangle.

aRect
frameWidth
Description forthcoming.
aRect
frameWidth
op
Description forthcoming.
context
virtualMemory
windowBackingMemory
windowDumpStream
Description forthcoming.
aRect
Description forthcoming.
colorSpaceName
Description forthcoming.
depth
Description forthcoming.
location
Description forthcoming.
aRect
Description forthcoming.
rects
count
Description forthcoming.
aRect
Description forthcoming.
rects
count
Description forthcoming.
rects
count
op
Description forthcoming.
rects
colors
count
Description forthcoming.
rects
colors
num
op
Description forthcoming.
rects
grays
count
Description forthcoming.
aRect
op
Description forthcoming.
placement
Description forthcoming.
size
list
Description forthcoming.
context
size
list
Description forthcoming.
NSInterfaceStyle functions

key
responder

Returns the interface style the responder should use, which affects how a UI element (such as a button or menu) is displayed. If the responder has an interface style set, the key is ignored and the responder's interface style is returned. Otherwise the style associated with the key is returned (if set), otherwise the default style is returned. In no case will the style `NSNoInterfaceStyle` be returned.

Styles can be set using the user defaults system. Currently available styles are

NSNextStepInterfaceStyle
NSMacintoshInterfaceStyle
NSWindows95InterfaceStyle
GSWindowMakerInterfaceStyle

You can set a default style for all UI elements using the `NSInterfaceStyleDefault` key:

defaults write NSGlobalDomain NSInterfaceStyleDefault GSWindowMakerInterfaceStyle
NSKeyValueBinding functions

object
Description forthcoming.
NSPanel functions

title
exception
defaultButton
alternateButton
otherButton
Description forthcoming.
title
defaultButton
alternateButton
otherButton
docWindow
modalDelegate
willEndSelector
didEndSelector
contextInfo
msg
Description forthcoming.
title
defaultButton
alternateButton
otherButton
docWindow
modalDelegate
willEndSelector
didEndSelector
contextInfo
msg
Description forthcoming.
title
defaultButton
alternateButton
otherButton
docWindow
modalDelegate
willEndSelector
didEndSelector
contextInfo
msg
Description forthcoming.
title
msg
defaultButton
alternateButton
otherButton
Description forthcoming.
title
msg
defaultButton
alternateButton
otherButton
Description forthcoming.
title
msg
defaultButton
alternateButton
otherButton
Description forthcoming.
panel
Description forthcoming.
title
msg
defaultButton
alternateButton
otherButton
Description forthcoming.
title
msg
defaultButton
alternateButton
otherButton
Description forthcoming.
title
msg
defaultButton
alternateButton
otherButton
Description forthcoming.
table
title
msg
defaultButton
alternateButton
otherButton
Description forthcoming.
NSPasteboard functions

fileType

Returns a standardised pasteboard type for file contents, formed from the supplied file extension.

Data written to a pasteboard with a file contents type should be written using the [NSPasteboard -writeFileContents:] or [NSPasteboard -writeFileWrapper:] method. Similarly, the data should be read using the [NSPasteboard -readFileContentsType:toFile:] or [NSPasteboard -readFileWrapper] method.

fileType

Returns a standardised pasteboard type for file names, formed from the supplied file extension.

Data written to a pasteboard with a file names type should be a single name written using [NSPasteboard -setString:forType:] or an array of strings written using [NSPasteboard -setPropertyList:forType:].
Similarly, the data should be read using the [NSPasteboard -stringForType:] or [NSPasteboard -propertyListForType:] method.

See also the NSGetFileType() and NSGetFileTypes() functions.

pboardType
Returns the file type (fileType extension) corresponding to the pasteboard type given.
This is a counterpart to the NSCreateFilenamePboardType() function.
pboardTypes
Returns the file types (filename extensions) corresponding to the pasteboard types given.
NSSound functions

Function used to retrieve all available playback devices.

This function is the only way to retrieve possible playback device identifiers understood by [NSSound -setPlaybackDeviceIdentifier:].

NSView functions

aView
Description forthcoming.
PSOperators functions

fmt
args
Description forthcoming.
Description forthcoming.
buf
count
Description forthcoming.
x
y
r
angle1
angle2
Description forthcoming.
x
y
r
angle1
angle2
Description forthcoming.
x1
y1
x2
y2
r
Description forthcoming.
x
y
s
Description forthcoming.
cx
cy
c
ax
ay
s
Description forthcoming.
s
b
Description forthcoming.
Description forthcoming.
Description forthcoming.
x
y
w
h
gstateNum
dx
dy
op
Description forthcoming.
x
y
w
h
op
Description forthcoming.
m
Description forthcoming.
d
c
Description forthcoming.
a
Description forthcoming.
c
m
y
k
Description forthcoming.
flatness
Description forthcoming.
gray
Description forthcoming.
h
s
b
Description forthcoming.
linecap
Description forthcoming.
linejoin
Description forthcoming.
width
Description forthcoming.
limit
Description forthcoming.
x
y
Description forthcoming.
r
g
b
Description forthcoming.
b
Description forthcoming.
x1
y1
x2
y2
x3
y3
Description forthcoming.
x
y
w
h
gstateNum
dx
dy
delta
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
x
y
Description forthcoming.
x
y
Description forthcoming.
Description forthcoming.
llx
lly
urx
ury
Description forthcoming.
x1
y1
x2
y2
x3
y3
Description forthcoming.
x
y
w
h
Description forthcoming.
x
y
w
h
Description forthcoming.
x
y
w
h
Description forthcoming.
Description forthcoming.
x
y
Description forthcoming.
x
y
Description forthcoming.
angle
Description forthcoming.
x
y
Description forthcoming.
a
Description forthcoming.
c
m
y
k
Description forthcoming.
pat
size
offset
Description forthcoming.
flatness
Description forthcoming.
gray
Description forthcoming.
gst
Description forthcoming.
x
y
Description forthcoming.
h
s
b
Description forthcoming.
linecap
Description forthcoming.
linejoin
Description forthcoming.
width
Description forthcoming.
limit
Description forthcoming.
r
g
b
Description forthcoming.
b
Description forthcoming.
shaderDictionary
Description forthcoming.
s
Description forthcoming.
Description forthcoming.
x
y
Description forthcoming.
x
y
c
s
Description forthcoming.
d
c
array
Description forthcoming.
s
numarray
size
Description forthcoming.
s
numarray
size
Description forthcoming.
s
numarray
size
Description forthcoming.
NSTextAttachment macros

NSTextAttachment is used to represent text attachments. When inline, text attachments appear as the value of the NSAttachmentAttributeName attached to the special character NSAttachmentCharacter. NSTextAttachment uses an object obeying the NSTextAttachmentCell protocol to get input from the user and to display an image. NSTextAttachmentCell is a simple subclass of NSCell which provides the NSTextAttachment protocol.
NSTextContainer macros

A text container defines a region in the plane. It is used by the text system to lay out text: text is laid out inside this region. A layout manager has a list of text containers that it lays out text in. A text container may have one NSTextView attached to it that displays the text laid out in the text container. Note that the coordinate system used by NSTextContainer is the same as in the rest of the text system classes, ie. positive y is down. NSTextContainer itself defines a simple rectangular region as large as the container size. In most cases, only a single, simple text container is used with a layout manager and a text view. Examples of cases where you might want to use several text containers, or subclasses that define more complex regions, are: Multi-page layout; one text container for each page. Multi-column layout; one text container for each column. Layout flowing around pictures; the text container would define a region that does not include the space used by the picture. If the region defined by a text container can change dynamically, the text container should call [GSLayoutManager -textContainerChangedGeometry:] whenever this happens.