SK8 0.9 Object Ref

8/8/2019 SK8 0.9 Object Ref

1/1007

SK8 Object Reference

Version 0.9

CONFIDENTIAL

Brought to you by the SK8 Development Team.

1995 Apple Computer, Inc. All rights reserved. No part of this publication may bereproduced, transmitted, transcribed, stored in a retrieval system, or translated into

any language in any form by any means without the written permission of AppleComputer, Inc.


2/1007

1995 Apple Computer, Inc. 5/7/95

Apple Computer, Inc.

1995, Apple Computer, Inc.All rights reserved.

No part of this publication or thesoftware described in it may bereproduced, stored in a retrieval

system, or transmitted, in any form orby any means, mechanical, electronic,photocopying, recording, or otherwise,without prior written permission ofApple Computer, Inc., except in thenormal use of the software or to make a

backup copy of the software. The sameproprietary and copyright notices must

be affixed to any permitted copies aswere affixed to the original. Thisexception does not allow copies to bemade for others, whether or not sold,

but all of the material purchased (withall backup copies) may be sold, given,or loaned to another person. Under thelaw, copying includes translating intoanother language or format. You mayuse the software on any computerowned by you, but extra copies cannot

be made for this purpose.

Printed in the United States of America.

The Apple logo is a registeredtrademark of Apple Computer, Inc.Use of the keyboard Apple logo(Option-Shift-K) for commercialpurposes without the prior writtenconsent of Apple may constitutetrademark infringement and unfaircompetition in violation of federal andstate laws.

No licenses, express or implied, aregranted with respect to any of thetechnology described in this book.

Apple retains all intellectual propertyrights associated with the technologydescribed in this book. This book isintended to assist applicationdevelopers to develop applications onlyfor Apple Newton computers.

Apple Computer, Inc.20525 Mariani AvenueCupertino, CA 95014408-996-1010

Apple, the Apple logo, APDA,LaserWriter, the light bulb logo,Macintosh, and Newton are trademarksof Apple Computer, Inc., registered inthe United States and other countries.

Newton ToolKit and QuickDraw are

trademarks of Apple Computer, Inc.Simultaneously published in the UnitedStates and Canada.

LIMITED WARRANTY ON MEDIA AND

REPLACEMENT

If you discover physical defects in the

manual or in the media on which a software

product is distributed, APDA will replace

the media or manual at no charge to you

provided you return the item to be replacedwith proof of purchase to APDA.

ALL IMPLIED WARRANTIES ON THIS

MANUAL, INCLUDING IMPLIED

WARRANTIES OF MERCHANTABILITY

AND FITNESS FOR A PARTICULAR

PURPOSE, ARE LIMITED IN DURATION

TO NINETY (90) DAYS FROM THE DATE

OF THE ORIGINAL RETAIL PURCHASE

OF THIS PRODUCT.

Even though Apple has reviewed this

manual, APPLE MAKES NO WARRANTY

OR REPRESENTATION, EITHER EXPRESS

OR IMPLIED, WITH RESPECT TO THIS

MANUAL, ITS QUALITY, ACCURACY,

MERCHANTABILITY, OR FITNESS FOR A

PARTICULAR PURPOSE. AS A RESULT,THIS MANUAL IS SOLD AS IS, AND

YOU, THE PURCHASER, ARE ASSUMING

THE ENTIRE RISK AS TO ITS QUALITY

AND ACCURACY.

IN NO EVENT WILL APPLE BE LIABLE

FOR DIRECT, INDIRECT, SPECIAL,

INCIDENTAL, OR CONSEQUENTIAL

DAMAGES RESULTING FROM ANY

DEFECT OR INACCURACY IN THIS

MANUAL, even if advised of the possibility

of such damages.

THE WARRANTY AND REMEDIES SET

FORTH ABOVE ARE EXCLUSIVE AND IN

LIEU OF ALL OTHERS, ORAL OR

WRITTEN, EXPRESS OR IMPLIED. No

Apple dealer, agent, or employee isauthorized to make any modification,

extension, or addition to this warranty.

Some states do not allow the exclusion or

limitation of implied warranties or liability

for incidental or consequential damages, so

the above limitation or exclusion may not

apply to you. This warranty gives you

specific legal rights, and you may also have

other rights which vary from state to state.


3/1007

Page iii

Table of Contents

Object Reference ..............................................................................................................1

Abort ...............................................................................................................................1

AbortCondition ...............................................................................................................2

AbstractClock .................................................................................................................3

Actor ...............................................................................................................................5

ActorCollection ..............................................................................................................102

AETarget ........................................................................................................................103

AnimatedClock ...............................................................................................................104

AnimatedCursor ..............................................................................................................105

AppleEvent .....................................................................................................................107

AppleEventError .............................................................................................................112

AppleEventReceiver .......................................................................................................112

AppleScript .....................................................................................................................114

AppleScriptResult ...........................................................................................................117

AppleTalkError ...............................................................................................................118

ArgumentTypeMismatchError .......................................................................................118

ArithmeticError ..............................................................................................................119

ArithmeticOverflowError ...............................................................................................120

Arrow ..............................................................................................................................121

BevelRenderer ................................................................................................................124

BigFloat ..........................................................................................................................127BigInteger .......................................................................................................................128

BringUpHandler .............................................................................................................128

BrowserComponent ........................................................................................................129

BrowserMenuBar ............................................................................................................132

BrowserPaper ..................................................................................................................133

BWPattern ......................................................................................................................133

ByteStream .....................................................................................................................136

CantChangeConstantError ..............................................................................................136

Character .........................................................................................................................137

CheckBox .......................................................................................................................138

ChooseResponse .............................................................................................................142clipBoard ........................................................................................................................143

Clock ...............................................................................................................................149

ClockError ......................................................................................................................155

CoercionError .................................................................................................................155


4/1007

Page iv

Collection ....................................................................................................................... 157

ColorCursorRSRC ......................................................................................................... 175

ColorPattern ................................................................................................................... 175

ColorPicker .................................................................................................................... 178

CompilationError ........................................................................................................... 179

Complex ......................................................................................................................... 179

ComplexGradient ........................................................................................................... 180

ComplexRGBColor ........................................................................................................ 185

ComponentManagerError .............................................................................................. 189

Condition ....................................................................................................................... 189

ConditionResponse ........................................................................................................ 190

ConditionSystemError ................................................................................................... 192

Connector ....................................................................................................................... 193

ConstantSheet ................................................................................................................ 197

ConstantSheetPicker ...................................................................................................... 197CursorRSRC .................................................................................................................. 197

DataObject ..................................................................................................................... 198

DateTime ........................................................................................................................ 198

Device ............................................................................................................................ 210

DialogBox ...................................................................................................................... 211

DialogBoxButton ........................................................................................................... 211

DialogBoxCancelButton ................................................................................................ 212

DialogBoxDisplayEditText ............................................................................................ 213

DialogBoxDisplayRectangle .......................................................................................... 213

DialogBoxEditText ........................................................................................................ 214

DialogBoxHighlightedButton ........................................................................................ 214DialogBoxLabel ............................................................................................................. 215

directionalConnector ...................................................................................................... 215

DirectoryError ................................................................................................................ 216

DirectoryNickname ........................................................................................................ 216

DiskError ........................................................................................................................ 217

DisplayErrorMessage ..................................................................................................... 218

DivisionByZeroError ..................................................................................................... 219

DrawTool ....................................................................................................................... 220

DrawToolPalette ............................................................................................................ 223

EditMenu ........................................................................................................................ 224

EditText .......................................................................................................................... 224EditTextCollection ......................................................................................................... 246

Effect .............................................................................................................................. 246

EmptyAppleScriptResult ............................................................................................... 247

EndOfFileError .............................................................................................................. 247


5/1007

Page v

EnumeratedType .............................................................................................................247

Error ................................................................................................................................248

ErrorColor .......................................................................................................................249

EventMode ......................................................................................................................250

EventModeError .............................................................................................................254

ExitModeWithError ........................................................................................................255

File ..................................................................................................................................256

FileChooser .....................................................................................................................273

FileError ..........................................................................................................................278

FileList ............................................................................................................................279

FileMemoryFullError .....................................................................................................279

FileMenu .........................................................................................................................279

FileName ........................................................................................................................280

FileNotFoundError .........................................................................................................281

FilePopUp .......................................................................................................................281FileSystemError ..............................................................................................................282

Float ................................................................................................................................282

Font .................................................................................................................................283

ForeignDeftrap ................................................................................................................284

ForeignMemory ..............................................................................................................285

Function ..........................................................................................................................286

FunctionSheet .................................................................................................................287

FunctionSheetPicker .......................................................................................................287

GeneralError ...................................................................................................................287

GeneralProgrammaticError ............................................................................................289

GetFromUserButton .......................................................................................................289GetObjectField ................................................................................................................291

Gradient ..........................................................................................................................294

Graphic ...........................................................................................................................298

halo .................................................................................................................................298

Handler ...........................................................................................................................300

HandlerDataRect ............................................................................................................301

HandlerList .....................................................................................................................302

HandlerPicker .................................................................................................................303

HandlerSheet ..................................................................................................................303

HandlerSheetPicker ........................................................................................................303

HandlerViewer ................................................................................................................303HandlerViewerText ........................................................................................................304

HandlerWatchingComponent .........................................................................................304

Hatch ...............................................................................................................................305

HierarchicalObjectList ....................................................................................................309


6/1007

Page vi

HierarchicalObjectPicker ............................................................................................... 310

HierarchicalPicker .......................................................................................................... 312

HierarchicalPickerItem .................................................................................................. 314

Highlighted .................................................................................................................... 316

IconRSRC ...................................................................................................................... 317

IconTextPicker ............................................................................................................... 319

IllegalFilenameError ...................................................................................................... 323

ImageCompressionError ................................................................................................ 323

ImageRenderer ............................................................................................................... 324

IncorrectArgumentsError ............................................................................................... 331

IncorrectSubscriptsError ................................................................................................ 333

IndexOutOfBoundsError ................................................................................................ 334

IndirectText .................................................................................................................... 335

InputOutputPort ............................................................................................................. 341

InputPort ........................................................................................................................ 344Integer ............................................................................................................................ 346

IODriverError ................................................................................................................ 346

Keyboard ........................................................................................................................ 346

Label .............................................................................................................................. 347

Line ................................................................................................................................ 350

linearTextPicker ............................................................................................................. 350

LineSegment .................................................................................................................. 354

LogErrorMessage ........................................................................................................... 364

MacAlertBox .................................................................................................................. 365

MacAnimation ............................................................................................................... 366

MacBarberPole .............................................................................................................. 369MacButton ...................................................................................................................... 369

MacCheckBox ................................................................................................................ 371

MacDialog ...................................................................................................................... 371

MacFinderArrow ............................................................................................................ 372

MacMenuItem ................................................................................................................ 374

MacModalDialog ........................................................................................................... 374

MacMovableModalDialog ............................................................................................. 375

MacPopupMenu ............................................................................................................. 375

MacProgressIndicator .................................................................................................... 375

MacRadioButton ............................................................................................................ 377

MacRoundIndicator ....................................................................................................... 378MacScrollBar ................................................................................................................. 378

MacScrollingList ............................................................................................................ 380

MacWidget ..................................................................................................................... 381

mask ............................................................................................................................... 382


7/1007

Page vii

MaskedActor ..................................................................................................................383

MaybeOpenProject .........................................................................................................385

Media ..............................................................................................................................386

MemHandle ....................................................................................................................390

MemoryFullError ............................................................................................................390

MemoryManagerError ....................................................................................................390

MemPointer ....................................................................................................................391

Menu ...............................................................................................................................391

MenuBar .........................................................................................................................408

MenubarCollection .........................................................................................................414

MenuBarEditorPicker .....................................................................................................415

MenuCollection ..............................................................................................................417

MenuEditorPicker ...........................................................................................................417

MenuForConPickers .......................................................................................................419

MenuForFunPickers .......................................................................................................419MenuForHandlerPickers .................................................................................................420

MenuForHierarchicalObjectPickers ...............................................................................421

MenuForMenuEditorPickers ..........................................................................................421

MenuForObjectPickers ...................................................................................................423

MenuForPropertyPickers ................................................................................................424

MenuForValueEditorPickers ..........................................................................................425

MenuForVarPickers ........................................................................................................426

MenuItem ........................................................................................................................426

MenuManagerError ........................................................................................................435

MenuSpacer ....................................................................................................................436

MinutesClock ..................................................................................................................436MixinForObjectPickers ..................................................................................................436

MixinForObjectPiles ......................................................................................................439

MixinForProjectDataPickers ..........................................................................................440

MixinForPropertyHandlerPickers ..................................................................................443

Monitor ...........................................................................................................................448

Mouse .............................................................................................................................451

MovieControllerError .....................................................................................................453

MovieDataHandlerError .................................................................................................453

MovieError .....................................................................................................................453

MovieRectangle ..............................................................................................................453

MovieSequenceGrabberError .........................................................................................454MultiLinePicker ..............................................................................................................454

MultiObjectStateCheckbox ............................................................................................456

MultiRenderer .................................................................................................................459

NameField ......................................................................................................................461


8/1007

Page viii

NonNegativeInteger ....................................................................................................... 461

NoResponse ................................................................................................................... 462

NotAHandlerError ......................................................................................................... 463

Number .......................................................................................................................... 464

NumberMemoryFullError .............................................................................................. 464

NumberPropertyEditor ................................................................................................... 464

Object ............................................................................................................................. 465

ObjectDataRect .............................................................................................................. 497

ObjectList ....................................................................................................................... 499

ObjectPicker ................................................................................................................... 499

ObjectPile ....................................................................................................................... 499

ObjectPilePicker ............................................................................................................ 500

ObjectTable .................................................................................................................... 500

OSHeapFullError ........................................................................................................... 500

OutputPort ...................................................................................................................... 501Oval ................................................................................................................................ 503

Paragraph ....................................................................................................................... 505

pen .................................................................................................................................. 505

Picker ............................................................................................................................. 516

PickerCollection ............................................................................................................. 531

PickerMenu .................................................................................................................... 531

PickerMenuItem ............................................................................................................. 534

PickerMenuItemSpacer .................................................................................................. 535

PixelMap ........................................................................................................................ 535

Pointer ............................................................................................................................ 537

Polygon .......................................................................................................................... 538Port ................................................................................................................................. 548

PositiveInteger ............................................................................................................... 554

PPCToolboxError .......................................................................................................... 555

ProgrammaticError ........................................................................................................ 555

project ............................................................................................................................ 555

ProjectDataPicker .......................................................................................................... 567

ProjectDataSheet ............................................................................................................ 567

ProjectDataSheetPicker .................................................................................................. 567

ProjectImproperlyClosedError ....................................................................................... 568

PropertyControlPanel ..................................................................................................... 568

PropertyDataRect ........................................................................................................... 572PropertyHandlerList ....................................................................................................... 574

PropertyHandlerPicker ................................................................................................... 574

PropertyHandlerSheet .................................................................................................... 574

PropertyHandlerSheetPicker .......................................................................................... 575


9/1007

Page ix

PropertyList ....................................................................................................................575

PropertyPicker ................................................................................................................575

PropertySheet ..................................................................................................................575

PropertySheetPicker .......................................................................................................576

PropertyTypeMismatchError ..........................................................................................576

Proxy ...............................................................................................................................577

QDPicture .......................................................................................................................578

QDPictureToPictTranslator ............................................................................................581

QueryField ......................................................................................................................581

QuickTimeCallBack .......................................................................................................583

QuickTimeCallBackAtExtremes ....................................................................................588

QuickTimeCallBackAtRate ............................................................................................589

QuickTimeCallBackAtTime ...........................................................................................590

QuickTimeCallBackAtTimeJump ..................................................................................592

QuickTimeCallBackForRenderer ...................................................................................592QuickTimeMedia ............................................................................................................593

QuickTimeMovie ............................................................................................................594

QuickTimeRenderer .......................................................................................................621

QuickTimeTimeBase ......................................................................................................656

QuickTimeTrack .............................................................................................................663

QuickTimeTrackCollection ............................................................................................666

RadioButton ....................................................................................................................666

Real .................................................................................................................................670

RealTimeClock ...............................................................................................................670

Rectangle ........................................................................................................................673

Renderer ..........................................................................................................................677ResourceChooser ............................................................................................................681

ResourceError .................................................................................................................682

RGBColor .......................................................................................................................683

RootDirectory .................................................................................................................685

RoundRect ......................................................................................................................685

safeInputPort ...................................................................................................................688

safeOutputPort ................................................................................................................689

ScrapManagerError ........................................................................................................689

ScriptEditorWindow .......................................................................................................689

ScriptEditText .................................................................................................................696

ScriptExpression .............................................................................................................713ScriptSyntaxError ...........................................................................................................714

Scroller ............................................................................................................................715

scrollerArrow ..................................................................................................................724

ScrollerBody ...................................................................................................................724


10/1007

Page x

ScrollerDownArrow ....................................................................................................... 725

ScrollerThumb ............................................................................................................... 726

ScrollerUpArrow ............................................................................................................ 727

SecondsClock ................................................................................................................. 729

SelectByRowTablePickerAddOn .................................................................................. 729

SelectionDots ................................................................................................................. 731

SelectionTool ................................................................................................................. 733

SerialPortError ............................................................................................................... 736

SimpleMenubar .............................................................................................................. 736

SimplePropertyEditor .................................................................................................... 736

SK8 ................................................................................................................................738

sk8Clipboard .................................................................................................................. 739

SK8Directory ................................................................................................................. 739

SK8HeapFullError ......................................................................................................... 740

SketchRenderer .............................................................................................................. 740SlaveClock ..................................................................................................................... 743

Slider .............................................................................................................................. 744

SmallFloat ...................................................................................................................... 744

SmallInteger ................................................................................................................... 745

SoundManagerError ....................................................................................................... 745

SoundRSRC ................................................................................................................... 745

splitter ............................................................................................................................ 747

StackOverflowError ....................................................................................................... 751

StackWatcher ................................................................................................................. 752

Stage ............................................................................................................................... 754

StorageDevice ................................................................................................................ 764Stream ............................................................................................................................ 766

StyledPicker ................................................................................................................... 767

SwatchRenderer ............................................................................................................. 769

Symbol ........................................................................................................................... 771

System ............................................................................................................................ 772

SystemClock .................................................................................................................. 780

SystemError ................................................................................................................... 780

Table .............................................................................................................................. 781

TablePair ........................................................................................................................ 782

TablePicker .................................................................................................................... 782

TablePickerEditor .......................................................................................................... 808TablePickerEditorAddOn .............................................................................................. 809

tbSketchRenderer ........................................................................................................... 811

Text ................................................................................................................................ 813

TextChunk ...................................................................................................................... 819


11/1007

Page xi

textField ..........................................................................................................................820

textList ............................................................................................................................822

TextStream ......................................................................................................................832

ThisApplicationAETarget ..............................................................................................837

Today ..............................................................................................................................837

translator .........................................................................................................................838

TwoByNBrowserPicker ..................................................................................................844

TwoNumberPropertyEditor ............................................................................................846

TypeMismatchError ........................................................................................................847

TypeTable .......................................................................................................................849

UI ....................................................................................................................................849

uiRectangleInBevel ........................................................................................................849

uiRectangleOutBevel ......................................................................................................849

UnboundVariableError ...................................................................................................850

UndefinedHandlerError ..................................................................................................851UndoableSetLog .............................................................................................................852

UnknownError ................................................................................................................854

ValueEditor .....................................................................................................................854

ValueEditorPicker ..........................................................................................................855

ValueText .......................................................................................................................857

VariableSheet ..................................................................................................................858

VariableSheetPicker .......................................................................................................859

VirtualType .....................................................................................................................859

VisualEffect ....................................................................................................................860

WindowsMenu ................................................................................................................860

Word ...............................................................................................................................860ZoomIn ...........................................................................................................................861

Functions ...........................................................................................................................863

Constants ..........................................................................................................................963

Global Variables ...............................................................................................................969


12/1007

Page xii


13/1007

i n v o k e o f A b o r t

Page 1

Draft. Confidential. 1995 Apple Computer, Inc. 5/8/95

Object Reference

Abort

(a ConditionResponse)

Invoking this response aborts the current event-processing, dropping back down into the current event

loop.If the currentCondition

is an AbortCondition

and its exitBreak

property is True

, it also abortsthe current event loop, dropping back down into the event loop below it.

This response is always invokable.

See Also

abortEvent

, abortBreak

, abortError

, AbortCondition

, ConditionResponse

, the ConditionSystem section of the User Guide's SK8Script Language chapter

Handlers of Abort

invoke of Abort

invoke me

This handler aborts the current event-processing, dropping back down into the currentevent loop.

If the currentCondition

is an AbortCondition

and its exitBreak

property isTrue

, it also aborts the current event loop, dropping back down into the event loop below

it.

See Also

abortEvent

, abortBreak

, abortError

, ConditionResponse

me

(an Abort)


14/1007

w r i t e O b j e c t o f A b o r t

Page 2


writeObject of Abort

writeObject me, thestream, rereadably

If rereadably

is True

, this just does the inherited writeObject

behavior. Otherwise it

writes a description of what the Abort

response will do when invoked.

See Also

ConditionResponse

, writeObject

of Object

AbortCondition

(a Condition)

Properties of AbortCondition

exitbreak of AbortCondition

Getter

get the exitBreak of me

Setter

set the exitbreak of me

to NewValue

handlerargument of AbortCondition

Getter

get the handlerArgument of me

me

(an Abort)

theStream

rereadably


15/1007

p o s t a b o r t h a n d l e r o f A b o r t C o n d i t i o n

Page 3


Setter

set the handlerargument of me

to NewValue

postaborthandler of AbortCondition

Getter

get the postAbortHandler of me

Setter

set the postaborthandler of me

to NewValue

AbstractClock

(an Object)

This object is the root of the SK8 clock hierarchy. It encapsulates the functionality required for objects thatorchestrate time lines. It has one notorious child: Clock

.

All the handlers defined on AbstractClock do nothing. They become meaningfull in some of its

descendants. The documentation of this object just explains what these handlers mean.

See Also

Clock

and its knownChildren .

Handlers of AbstractClock

pause of AbstractClock

pause me

The command issued to pause the simulation/animation that this clock controls.

me (a AbstractClock)


16/1007

p l a y o f A b s t r a c t C l o c k

Page 4


play of AbstractClock

play me

Command issued to play any simulations that are tied to this clock.

start of AbstractClock

start me

This is the command issued to start running the clock.

started of AbstractClock

started me

This handler is called when the clock starts running.

stop of AbstractClock

stop me

This is the command that is issued to make the clock stop running.

stopped of AbstractClock

stopped me

Returns True if the clock is not currently running.

tick of AbstractClock

tick me







17/1007

t i c k o f A b s t r a c t C l o c k

Page 5


This handler is called each time the clock ticks and it marks the unit of time in the clock'slogical time scale.

Actor(an ActorCollection, Graphic)

An actor is a graphical object: it has a geometry and can be displayed on the screen. In fact, every SK8object you see on the Stage is a descendant of Actor.

The actor's geometry is defined by three masks (or regions): the boundsRegion, the fillRegion andthe frameRegion . The boundsRegion is the space the whole actor takes. The frameRegion is theperimeter of the bounds. Its size is specified by the frameSize property. The frameRegion can beempty (when the framesize = {0,0}). The fillRegion is the space inside the frame, or moregenerally, the difference between the bounds and the frame.

Each actor has three handlers which compute these masks: makeBoundsRegion, makeFillRegion and makeFrameRegion . If you want the implement a new geometry, these handlers will have to beredefined.

Most of SK8 users, however, will never need to do this. The actor's size and location are manipulatedusing the boundsRect property. The boundsRect specifies a rectangle within which the actor's boundswill be inscribed. The boundsRect is represented as a list of 4 numbers of the form {left, top,right, bottom}.

The actor's masks are also used for drawing. The frameRegion is rendered with the actor'sframeColor. The fillRegion is rendered with the actor's fillColor. Any actors that are contained

by an actor are drawn clipped to the fillRegion .

Actor is the most prolific child of Graphic with numerous children of its own.

Note: Actors carry with them a lot of information that is required to display them graphically. Thus, youshould only use actors for objects that are inherently graphical.x



18/1007

a c c e p t s d r o p s o f A c t o r

Page 6


Properties of Actor

acceptsdrops of Actor

This property determines whether the actor requests drop events from SK8. If True (thedefault), then SK8 will send a drop event to the actor whenever another actor is droppedonto it (typically at the end of a drag process).

Getter

get the acceptsDrops of me

Setter

set the acceptsdrops of me

to NewValue

Example

Let us build a Disposer: a rectangle that removes from the Stage whatever is dropped onit (it sets the container of the dropped actor to false).

The Disposer can be switched off by setting its acceptsDrops property to False. Wewill provided a visual indication of the status of our Disposer: when it is ON we will setits text to "Disposer On!" and paint it Red, when it is OFF we will set its text to "Out ForLunch" and paint it White.

We make the Disposer:

new rectangle with objectName "Disposer"

The first thing we need to do is define its set acceptDrops handler to change itsappearance.

me (an Actor)

me (an Actor)to (a boolean): Whether to tell the actor to accept drop events.


19/1007

a u t o h i g h l i g h t o f A c t o r

Page 7


on set acceptsDrops of me (a Disposer) to newValue

-- do inherited to set the property!

do inherited

-- now change its appearance.

if newValue thenset my fillcolor to Red

set my text to "Disposer On!"

else

set my fillcolor to White

set my text to "Out For Lunch"

end if

end set acceptsDrops

Finally, we define the dropped handler of the Disposer to set the container of whatever isdropped into it to False. Note that this handler will only be called by the system whenthe acceptsDrops of the Disposer is true.

on dropped of me (a Disposer), dropee

set the container of dropee to Falseend drop

To test our object, we can put it on the Stage, set its acceptsDrops property to Trueand drop other actors into it.

See Also

drop, dropped and drag handlers.

autohighlight of Actor

The autohighlight property determines whether an actor will get highlighted (its sethighlight handler will be called) when the mouse goes down on it. The default isFalse .

Getter

get the autoHighlight of me

Setter

set the autohighlight of meto NewValue

me (an Actor)

me (an Actor)to (a boolean): Whether to make this actor autohighlight when clicked on.


20/1007

a u t o t a b o f A c t o r

Page 8


See Also

set highlight, highlight .

autotab of Actor

The autoTab property controls the function of the tab key when an actor is thekeyTarget of its window. If the autotab of the actor is True, pressing the tab sets thekeyTarget of its window to the next actor in the Actor's container whose autotab isTrue.

The tabToNextActor handler is called to find the next actor to become the keyTarget .

Getter

get the autoTab of me

Setter

set the autotab of me

to NewValue

See AlsotabToNextActor.

bottom of Actor

The bottom of the actor's boundsRect . This is a virtual property computed from theboundsRect .

Getter

get the bottom of me

with physical

me (an Actor)

me (an Actor)to (a boolean): Whether to make this actor autotabable.

me (an Actor)[with physical] (a boolean): If True, the bottom point is returned in physical

coordinates.


21/1007

b o t t o m o f A c t o r

Page 9


Setter

set the bottom of me

with physical

with relative

with resizing

to NewValue

Example

Consider a Rectangle called StickyRectangle . This rectangle has a property called"hostages" in which it keeps a list of actors whose bottoms are constrained to being at thesame v coordinate as StickyRectangle 's top. StickyRectangle has anotherproperty called "resizing" that specifies whether the hostages will be resized to conform tothe constraint. If it is False, the hostages are just moved.

We need to redefine stickyRectangle 's moved and resized handlers to make sure

that whenever it moves, the bottom of every hostage is kept in line.Notice that if StickyRectangle 's resizing property is False, the hostages's bottom ischanged without resizing, in effect moving the hostages as desired.

on moved of me (a StickyRectangle)

-- Important to do inherited to keep a number of things

-- in synch!

do inherited

set myTop to my top

repeat with poorHostage in my hostages

set the bottom of poorHostage

with resizing my resizing to myTop

end repeat

end moved

See Also

setLocation and setBoundsRect, boundsRect, left, top, right, h, v, andlocation .

me (an Actor)[with physical] (a boolean): If True, assumes that the bottom is specified in

physical coordinates.[with relative] (a boolean): If True, the current bottom of the Actor is

changed by the amount specified.[with resizing] (a boolean): If True (the default), setting the bottom of the

actor constrains all other boundsRect positions to remain as they are.The actor will thus be resized. If False, the actor will move to make its

boundsRect coincide with the new bottom position.to (a Number)


22/1007

b o u n d e d b y c o n t e n t s o f A c t o r

Page 10


boundedbycontents of Actor

If an actor's boundedByContents property is True, its boundsRect is constrained to bethe union of the boundsRect of all of its direct contents. In other words, the size of the

actor will always exactly match the total space taken up by the actors it contains. As aresult, the actor's boundsRect will automatically be constrained to change whenever theboundsRect of any of its contents changes.

Default: False.

Getter

get the boundedByContents of me

Setter

set the boundedbycontents of me

to NewValue

See Also

bindByContents .

boundsrect of Actor

The boundsRect property determines the location of an actor's four corners, and thereforedetermines the size and location of the actor.

Getter

get the boundsRect of me

with physical

Returns a list of four integers: the left, top, right and bottom points enclosing the actor'sframe area. The points lie within the frame area.

Note: While an actor such as an Oval has no corners, it still has a boundsRect property.In the case of Oval actors, the boundsRect property determines the largest oval in sizeand shape that can fit within its coordinates.x

me (an Actor)

me (an Actor)to (a boolean): Whether to make this actor be bounded by contents.


23/1007

b o u n d s r e g i o n o f A c t o r

Page 11


Setter

set the boundsrect of me

with physical

with relative

with justmoving

to NewValue

Sets the Actor's boundsRect to the rect specified. Calls setBoundsRect to set theboundsRect .

Example

get the boundsRect of the Actor with physical boolean

See Also

setBoundsRect for a detailed description of all the options, left, top, right, bottom,h, v, and location.

boundsregion of Actor

This property holds the mask that defines the bounds of the actor. This mask is computedautomatically by the system from the actor's boundsRect using themakeBoundsRegion handler.

Note: If the bounds region is not up to date, the getter for this property forces it to be

recomputed by callingmakeBoundsRegion

. Thus it is a really bad idea to callboundsRegion from within the body of your own makeBoundsRegion . Use getValue instead.x

Getter

get the boundsRegion of me

me (an Actor)[with physical] (a boolean): If True, the values are in physical rather than

logical coordinates. The default is False.

me (an Actor)[with physical]

[with relative]

[with justmoving]

to


24/1007

c a c h e s p i x m a p o f A c t o r

Page 12


Setterset the boundsregion of me

to NewValue

Sets the actors bounds mask to the mask specified.

Note: Setting this property is a bad idea since the system will automatically change themask any time the actor changes boundsRect or container.x

See Also

makeBoundsRegion .

cachespixmap of Actor

Getter

get the cachesPixmap of me

If cachesPixMap is True, then the actor's drawing information will be cached by thesystem. When an actor's drawing information is cached, the actor is drawn or re-drawnalmost instantly. The trade-off is that caching an actor's drawing information usesmemory, so if non-cached drawing speeds are acceptable for your project you mightchoose not to cache an object's drawing information.

This property defaults to False.

Note: caching will not be effective when the contents of the actor to be cached moves alot.x

Setter

set the cachespixmap of me

to NewValue

me (an Actor)

me (an Actor)to (a Mask): The mask to install in this property.

me (an Actor)


25/1007

c o l o r d e p t h o f A c t o r

Page 13


See Also

capturePicture of ImageRenderer for an alternative to using this handler.

colordepth of Actor

This property specifies the depth (i.e., the number of bits per pixel) the actor wants to usewhen drawing itself on the Stage. Thus, the colordepth directly affects the number ofcolors the actor will be able to display when it becomes a window.

The depth can be set as follows:

0 (as many colors as the main monitor can support)1 (black and white only)

2 (4 colors)

4 (16 colors)

8 (256 colors)

32 (millions of colors), and

False (as many colors as the main monitor can support but drawing directly to thescreen).

Setting the colordepth property to False forces the SK8 graphics engine to draw the

actor's components directly on the screen. This saves memory, but it may cause drawingto appear jerky when dragging other windows over the actor.

Defaults to 0.

Note: every actor in a window is drawn using the same colorDepth : the colorDepth of the window itself (the actor whose container is the Stage). Thus changing the colordepth of an Actor that is inside a window has no effect neither on itself nor on itswindow.x

Getter

get the colorDepth of me

Setter

set the colordepth of me

to NewValue

me (an Actor)to (a boolean)

me (an Actor)


26/1007

c o n t a i n e r o f A c t o r

Page 14


See Also

cachesPixmap, and colordepth for Monitor.

container of Actor

Getter

get the container of me

Returns the Actor's container. Can be False, the Stage or another actor.

Setter

set the container of me

with following

to NewValue

An actor may be contained by another actor, the Stage, or by nothing at all. Setting thecontainer to False removes the actor from its current container, if any. Setting the

container to the Stage makes the actor become a window.

The Actor's container is only changed if both the Actor and its potential new containerconsent to the containment change. This handler, thus, does the following:

If there is a new container, calls newContentOk to find out if it accepts the new content.Then the Actor's newContainerOk is called to see if the new container is acceptable. If

both these handlers returned True, the operation proceeds and the Actor changescontainer.

Note: An actor may not contain itself.Setting an actor's container to the Stage ensures that the actor and all of the actors that it

contains will be graphically visible. To contain an actor in theStage

means that the actorwill be drawn over the Stage. Thus, actors directly attached to the Stage behave likewindows. It is possible to attach any actor to the Stage: you may thus easily create, e.g.,oval windows when the need arises.x

me (an Actor)depth

me (an Actor)


27/1007

c o n t e n t s o f A c t o r

Page 15


Example

set myRect's container to the Stage

set myRect's container to false

See Also

contents, newContainerOK, newContentOK, layer.

contents of Actor

Getter

get the contents of me

Returns the contents of the actor as a list of actors in front to back order. If the actordoes not contain anything, then False is returned.

Setter

set the contents of me

to NewValue

You cannot set the contents property of actors. To add something to an actor'scontents you have to use the set container handler.

See Also

set container.

dofirstclick of Actor

This property specifies whether the actor wants to get a mouseDown event when it is notthe selected window and the user clicks on it. If set to False, when the actor is a windowand it is clicked on, it gets an activate event. If set to True, in addition to theactivate event, a mousedown event is sent.

me (an Actor)[with following]: False or another Actor. If the this argument is supplied,

the actor is placed "under" the actor specified in this argument (the

Actor will be placed in the immediate next layer).to: False, the Stage or an Actor.

me (an Actor)


28/1007

d o u b l e c l i c k s t y l e o f A c t o r

Page 16


Defaults to False.

Getter

get the doFirstClick of me

Setter

set the dofirstclick of me

to NewValue

doubleclickstyle of Actor

The doubleClickStyle property specifies the manner in which an actor combinesmouseDown events into clicks/doubleClicks .

Getter

get the doubleClickStyle of me

Returns the manner in which an actor combines mouseDown events into clicks/doubleClicks. The options are:

'standard' : clicks and doubleclicks are generated when appropriate.

'clickOnly' : no doubleClicks are generated.

'doubleClickOnly' : no clicks are generated.

Defaults to 'standard' .

Setterset the doubleclickstyle of me

to NewValue

me (an Actor)


me (an Actor)

me (an Actor)to: One of 'standard', 'clickOnly' or 'doubleClickOnly' .


29/1007

d r a g g a b l e o f A c t o r

Page 17


draggable of Actor

When the draggable property of an actor is set to False, the actor may not be dragged.Setting the draggable property of an actor to True restores its ability to be dragged by the

mouse.

Note: This property only prevents the drag handler from dragging the actor (drag doesnothing if the Actor's draggable is False). It will have no effect on any other handlersthat you could use to do the dragging by hand.x

Getter

get the draggable of me

Setter

set the draggable of me

to NewValue

Example

To explain the note above, we could try to implement the drag handler ourselves. Wecould write a simple version of it as shown below. Since this handler does not check thedraggable property, the property will have no effect on whether you can drag the actoror not. The draggable property only works if you use the built-in drag handler.

on drag of me (an Actor)

repeat while the mouse is down

set {h,v} to the mouseloc of the Stage

-- since the mouseloc of the Stage is always returned

-- in physical coords, set the physical location!

set my location with physical to {h,v}

end repeat

end drag

fillColor of Actor

This property specifies the Renderer that is used to render (draw) the actor'sfillRegion .

Defaults to White.

me (an Actor)



30/1007


31/1007

fl o a t i n g o f A c t o r

Page 19


See Also

makeFillRegion .

floating of Actor

This property specifies whether an actor becomes a "windoid" when it is attached to theStage . When floating is True, the actor floats above all windows that are not floating.

Note: Use the layer property to change the layer of a windoid with respect to otherwindoids.x

Getter

get the floating of me

Setter

set the floating of me

to NewValue

framecolor of ActorReturns the Renderer used to render the Actor's frame. In SK8, a frame is the mask thatdefines the Actor's perimeter.

Defaults to Black.

Getter

get the frameColor of me

Setter

set the framecolor of me

to NewValue

Note: If you don't want the frame to be drawn, SK8 performs faster with the frameSize set to {0,0} than it does with the frameColor set to Transparent .x

me (an Actor)


me (an Actor)


32/1007

f r a m e h e i g h t o f A c t o r

Page 20


See Also

setFrameColorActor of Renderer, setFrameColorActor ofDynamicRenderer

frameheight of Actor

Specifies the size of the actor's frameRegion along the vertical axis. (The frame is theregion that defines the perimeter of an actor. )

Getter

get the frameheight of me

Setter

set the frameheight of me

to NewValue

Calls setFrameSize to set the size.

See Also

setFrameSize, frameSize, frameWidth .

frameregion of Actor

This property holds the mask that defines the frame of the actor. This mask is computed

automatically by the system from the actor's boundsRect using the makeFrameRegion handler.

Note: If the frame region is not up to date, the getter for this property forces it to berecomputed by calling makeFrameRegion . Thus it is a really bad idea to callframeRegion from within the body of your own makeFrameRegion . Use getValue instead.x

me (an Actor)to (a Renderer)

me (an Actor)

me (an Actor)to (a Number)


33/1007

f r a m e s i z e o f A c t o r

Page 21


Getter

get the frameRegion of me

Setter

set the frameregion of me

to NewValue

Sets the actors bounds mask to the mask specified.

Note: Setting this property is a bad idea since the system will automatically change themask any time the actor changes boundsRect or container.x

See Also

makeFrameRegion .

framesize of Actor

This property specifies the size of a frame's region as a list of two numbers: the firstnumber is for the frame's size along the horizontal axis (its width) and the second number

is for the size along the vertical axis (its height).

Getter

get the frameSize of me

with physical

Setter

set the framesize of mewith physical

to NewValue

Note: This handler calls setFramesize to actually do the work. Thus, you shouldredefine setFramesize if you need extra behavior.x

me (an Actor)

me (an Actor)to (a Mask): The mask to install in this property.

me (an Actor)[with physical] (a boolean): If True, the size in pixels is returned.


34/1007

f r a m e w i d t h o f A c t o r

Page 22


Example

get the frameSize of MyRect with physical

set the frameSize of MyRect to {4, 3}

See Also

frameWidth and frameHeight .

framewidth of Actor

Specifies the size of the Actor's frameRegion along the horizontal axis. (The frame is theregion that defines the perimeter of an actor. )

Getter

get the framewidth of me

Setter

set the framewidth of meto NewValue

Calls setFrameSize to do the work.

See Also

setFrameSize, frameHeight, frameSize .

h of Actor

Specifies the horizontal position of the center of the actor's boundsRect . This is a virtualproperty computed from the boundsRect property.

me (an Actor)[with physical] (a boolean): If True, the size is assumed to be given in pixels.to: A list of 2 numbers.

me (an Actor)



35/1007

h e i g h t o f A c t o r

Page 23


Getter

get the h of me

with physical

Setter

set the h of me

with physical

with relative

to NewValue

See Also

setLocation for an important note on redefining this handler.

height of ActorSpecifies the vertical size of the actor's boundsRect . This is a virtual property computedfrom the boundsRect property.

Getter

get the height of me

with physical

Setter

set the height of me

with physical

to NewValue

SetSize is called to do the work.

me (an Actor)[with physical] (a boolean): If True, the position is returned in physical

(Stage) coordinates.

me (an Actor)[with physical] (a boolean): If True, the number is assumed to be given in

Stage coordinates.[with relative] (a boolean): If True, the current horizontal location is

offsetted bv the number provided.to (a Number)

me (an Actor)[with physical]: If True, the size is returned in pixels.


36/1007

h i g h l i g h t o f A c t o r

Page 24


See Also

setSize and setBoundsRect, size.

highlight of Actor

This property specifies whether the Actor is currently highLighted. Graphically, beinghighlighted can mean any arbitrary change. The default behavior (which happens whenthe Actor's inverts property is True) is to render the actor with complementary colors.If the inverts property is set to False, custom highlighting can be done.

Getter

get the highlight of me

Setter

set the highlight of me

to NewValue

Sets the property and forces a graphical update to show the Actor in its highlighted (orunhighlighted) state.

Example

To do custom highlighting, you need to redefine the set highlight handler and makesure the inverts property is set to False. Here is an example of the code actually used

by the buttons in the file dialog:

me (an Actor)[with physical] (a boolean)to (a Number)

me (an Actor)

me (an Actor)[to]


37/1007

h o r i g i n o f A c t o r

Page 25


on set highlight of me (a dialogBoxButton) to newValue

-- it's important to call the next handler!

do inherited

-- do the hiliting by hand by setting the fillcolor!

if newValue thenset my fillcolor to InversebuttonGradientColor

else

set my fillcolor to buttonGradientColor

end if

end set hilite

See Also

inverts .

horigin of Actor

Specifies the horizontal component of the actor's origin. This is a virtual propertycomputed from the origin property.

Getter

get the horigin of me

Setter

set the horigin of meto NewValue

See Also

setOrigin, origin .

hscale of Actor

Specifies the horizontal component of the actor's scale. This is a virtual propertycomputed from the scale property.

Getter

get the hscale of me

me (an Actor)



38/1007

i n v e r t s o f A c t o r

Page 26


Setterset the hscale of me

to NewValue

Calls setScale to do the work.

See Also

setScale, scale.

inverts of Actor

Determines how the actor highlights itself. If inverts is True and you highlight an actor,the graphics system will invert the color of the actor. If inverts is False, the systemperforms no graphical change, giving you the freedom to do custom highlighting.

Defaults to True.

Getter

get the inverts of me

Setter

set the inverts of me

to NewValue

See Also

highlight for an example of how to do custom highlighting.

me (an Actor)

me (an Actor)to: A positive number.

me (an Actor)



39/1007

k e y t a r g e t o f A c t o r

Page 27


keytarget of Actor

Specifies which actor in this actor's contents gets key events when the actor becomes awindow (its container becomes the Stage).

Getter

get the keytarget of me

Setter

set the keytarget of me

to NewValue

Makes the actor in the to argument be the recipient of the actor's key events. Setting thekeyTarget of an actor not contained by the Stage has no effect. When the actor is awindow, the new keytarget actor (which should be in its contents) gets an activateText message.

A window may have either zero or one keyTarget actor. Typically, this will be an editabletext field.

When the autotab property of the keyTarget of the window is True, tabbing may causethe keyTarget to change (See the autotab property for details).

Example

Very often, we want a specific actor to be the keyTarget of its window when thewindow activates. An example of this is a dialog where we want the specific editText to beready to accept the user's input. We can redefine the activate event of the dialog for thispurpose. Consider a dialog called WeightDialog and an editText provided for enteringthe weight called WeightField .

on activate of me (a WeightDialog)-- It is important to call the next handler!

do inherited

set my keyTarget to the WeightField

end activate

See Also

activateText, autoTab, keyDown, keyUp, autoKey, and tabToNextActor.

me (an Actor)

me (an Actor)to (an Actor): The new actor to become keyTarget or False if you want tostop this window from dispatching key events to anyone.


40/1007

l a y e r o f A c t o r

Page 28


layer of Actor

Specifies the actor's position in the front-to-back order of its container's contents. Thelayer is a positive integer in the range of 1 to the number of actors in its container's

contents. Lower-numbered actors cover higher-numbered actors.

Note: Every SK8 actor is assigned a layer. If an actor contains eight actors, eachcontained actor is numbered from 1 to 8. Objects receive their number in the order theyappear in the contents of their container, i.e., from front to back, starting from 1. Whendealing with graphics, the layer property determines the precedence by which actorscover or are covered by other actors. Lower-numbered actors cover higher-numberedactors.Warning:Exercise care when referencing an actor by its layer property when writing scripts, sincean actor's layer is never permanently assigned (use the actor's objectName instead).Layer properties exist only to show an actor's place among other actors of its kind.

If, for example, an actor contains eight actors, deleting the first contained actor will causeeach of the remaining actors to have the value of their layer property reduced by one(valid actor numbers would now be from 1 to 7). Similarly, setting the layer of thehighest numbered actor to 1 automatically raises the layer of all other actors sharing thecontainer by 1.x

Getter

get the layer of me

Setter

set the layer of me

to NewValue

See Also

bringToFront, sendToBack, bringCloser and sendFarther.

left of Actor

The left of the actor's boundsRect . This is a virtual property computed from theboundsRect .

me (an Actor)

me (an Actor)to: A positive integer.


41/1007

l o c a t i o n o f A c t o r

Page 29


Getter

get the left of me

with physical

Setter

set the left of me

with physical

with relative

with resizing

to NewValue

See Also

setLocation and setBoundsRect, boundsRect, top, right, bottom, h, v, andlocation .

location of Actor

An actor's location is the center of its boundsRect .

Note: this is a virtual property computed from the actor's boundsRect . If you want to beabsolutely sure to catch all changes in location of your actor you should redefinesetBoundsRect since all geometrical changes go through that handler.x

Getter

get the location of me

with physical

me (an Actor)[with physical] (a boolean): If True, the left point is returned in physical

coordinates.

me (an Actor)[with physical] (a boolean): If True, assumes that the left is specified in

physical coordinates.[with relative] (

Date post:	10-Apr-2018
Category:	Documents
Upload:	pablomarx
View:	222 times
Download:	0 times

SK8 0.9 Object Ref

Documents