Wacky Windows Stuff...

home *** CD-ROM | disk | FTP | other *** search

/ Wacky Windows Stuff... / WACKY.iso / toolbook / learnos.tbk (.txt) < prev next >

Wrap

Asymetrix ToolBook File | 1990-09-26 | 92KB | 1,322 lines

Parameters Parts Special Terms Messages Literals Expressions Value References Constants Properties Variables Command Window Functions Operators 4stack_var "show_stack" :" && itemcnt enterPage enterPage show_stack itemCount: itemcnt stack_var show_stack 9170,6501,6335,8468,42798468,42255,1479,5725 Variable stk: "show_it" buttonup buttonup show_it New it 4stack_var "show_it" "show_stack" :" && itemcnt buttonUp buttonUp show_it show_stack itemCount: itemcnt stack_var 4stack_var "show_it" "show_stack" :" && itemcnt buttonUp buttonUp show_it show_stack itemCount: itemcnt stack_var show_it 5725 text It:ble stk: 4stack_var "some "show_stack" :" && itemcnt buttonUp buttonUp some text show_stack itemCount: itemcnt stack_var What??? itemcnt itemCount: 5654 itemCount: 6 4stack_var "XXX" "show_stack" :" && itemcnt buttonUp buttonUp show_stack itemCount: itemcnt stack_var put "XXX" into item 3 of stk key,isShift, isCtrl " && showit > 0 " && | && d > 0 " && > 0 ansitoChar(key) keyUp keyChar keyDown enterPage keyDown keyDown showit isCtrl isShift keyUp keyUp showit isCtrl isShift keyChar keyChar showit isCtrl isShift enterPage showit showit Messages Parameters Expressions Special Terms Object References Messages Messages in detail Examples of special terms get the third item of sysHistory go to last page of book "catalog.tbk" put "shirts" after text of field "laundry" draw a roundedRectangle from \ 1000,1000 to 3000,3000 Navigation commands flip, flip all fxDissolve, fxWipe, fxZoom search, search again Script control commands break, break to system continue, continue step edit script of execute forward, forward to system pause restore system Variable declaration commands local system User interface control commands ask, ask password magnify request Menu control commands add menu, remove menu add menuItem, remove menuItem check menuItem, uncheck menuItem activate menuItem, deactivate menuItem restore menuBar File and printing commandssssssssss save as, save changes print, print eject createFile openFile, closeFile readFile, writeFileee Data exchange commands import, export executeRemote, respondRemote getRemote, setRemote unlinkDLL Examples of commands fxDissolve slow to next page move group "cat" to 1000,1000 add menu "Categories" at Reader set the fillcolor of group "cow" to \ magenta Script Handlers Control Structures Object References Commands Containers String Specifiers Handlers Control Structures Script Handlers Statements Commands Parameters Responding to messages with message handlers Control Structures Control Structures Parameters Script Handlers Statements Commands Controlling order of processing with control structures Commands Control Structures Parameters Script Handlers Statements Commands Using OpenScript commands Expressions Expressions Expressing values in OpenScript Value References Literals Constants Containers Object References Parameters Expressions Special Terms Object References Messages Referring to objects Special Terms Parameters Expressions Special Terms Object References Messages Using special termsrs with special terms Using step, push, and pop * Use step to iterate through the items in a list * Use push to add an item to a list * Use pop to put an item from a list into It or into another variable Watch out for typos! * When setting properties, spell the property name correctly, otherwise: - You may define a data property instead of a built-in one by mistake - You may define a data property with a different name than you intendede wrong name Properties Containers Variables Properties Command Window Getting and setting properties Expressions Functions Operators String Specifiers Other ways of expressing values in OpenScript Command Window Containers Variables Properties Command Window Using the Command window in a script Functions Expressions Functions Operators String Specifiers Using functions to calculate values Operators Expressions Functions Operators String Specifiers Using operators to calculate values String Specifiers Expressions Functions Operators String Specifiers Referring to parts of a stringg Other considerations * Put the handler for a message no lower than the level of the object that receives the message * Be on the lookout for "unique" scripts that can be generalized, to reduce book size and script maintenancelized, to reduce book size and script maintenance showit leavePage leavePage showit }" & showit > 0 {" & A > 0 x > 0 > 0 |" & > 0 rightbuttonUp > 0 rightbuttonDown location " && > 0 z" & > 0 rightbuttonDoubleClick Q" & > 0 mouseLeave buttonDown buttonStillDown buttonUp rightbuttonUp rightbuttonDown mouseEnter buttonDoubleClick rightbuttonDoubleClick buttonUp buttonUp showit buttonDown buttonDown showit mouseEnter mouseEnter showit mouseLeave mouseLeave showit buttonStillDown buttonStillDown showit rightbuttonUp rightbuttonUp showit rightbuttonDown rightbuttonDown showit location buttonDoubleClick buttonDoubleClick showit rightbuttonDoubleClick rightButtonDoubleClick showit Button showit Containers - briefly * A container is anything that can hold a value * You refer to a container to work with its valuetable property - The Command window Containers - in detail * A container can be: - A variable - A settable property, including the text of a field - The Command window Variables * Use a variable to store information you don't want to appear on the page * OpenScript has three kinds of variables: - Local - System - Special Special variableses * The variable It is automatically declared and is used by commands such as get to store data * The variables argCount and argList contain the number of arguments and the actual arguments passed to a handler Local variables * A local variable persists for the execution of the handler it's in and is available only within that handler * local varname * If you don't use the local command, the variable is autodeclared with its first use useclared with its first use Variable names and initial values * A variable name must be unique and cannot be an OpenScript keyword * When you declare a variable its initial value is null * You set the value of a variable with the set command System variables * A system variable persists for the ToolBook session * system varname * A system variable is available to any handlermmand * A system variable is available to any handlererle is autodeclared with its first useiable is autodeclared with its first usee Properties * All objects have properties * ToolBook (the system) has properties * All properties are gettable, and most are settable * You can define your own properties Property settings * Many properties are limited to a predefined set of acceptable settings - borderStyle - fillColor, strokeColor - captionShown ou want More property settings * Other properties can contain a string of any content and sometimes of considerable length - script - text of a field - caption of a book or button Setting an object's property * Use the set command to set the property to a value or container: - set the caption of button "hint" \ to "Need a Hint?" - set the borderStyle of field "this" \ to the borderStyle of field "that" Getting the value of a property * Use put to put the value into a container * Use get to put the value into the special variable It - put vertices of selection into rickrack - get bounds of ellipse "cookie" Defining your own properties * You can define two kinds of properties: - Properties that contain data about an object - Properties that control behavior of an object Defining a data property * Use a data property when you want to store information about an object between ToolBook sessions * set myproperty of objectref \ to mysetting * The userProperties property contains a list of user-defined data properties Defining a behavior property * Define a behavior property when you want to restrict a property to certain settings or cause actions to happen when a setting changes * For details, see Chapter 6, "Beyond the Basics" in Using OpenScriptkok Command window * Use put without a destination to display data in the Command window * If the Command window is not already displayed, ToolBook will display it A function's to get handler to get myfunction varname statements return expression end myfunction * Return must be the last statement * Expression specifies the result to be calculated using the value passed in varname Using a user-defined function myfunction(varname) * Supply the appropriate value for varname * Same as for messages, if the to get handler for the function is lower in the hierarchy, use a direct reference: myfunction(varname) of button "foo" Operators in OpenScript * Arithmetic: * + - / ^ div mod * Logical: < <= <> = > >= contains, is, is not, is in, is not in, not, and, or * String: & && * Special: argument String specifiers * Use string specifiers to refer to part of a string * You can use string specifiers on any string: a string in a variable, an object property, or the text of a field The string specifiers character textline characters textlines char chars item items word words Specifying characters * You can refer to any character in a string, including spaces and special characters * Characters are counted from the beginning of the string * A carriage return and line feed at the end of a paragraph is TWO characters Specifying words * A word in OpenScript is any group of characters not separated by "white space" * "White space" is one or more spaces, tab characters, or CRLFs. Specifying textlines * A textline is zero or more characters up to but not including a CRLF * Think of a textline as a paragraph rather than a line of text, because lines of text in a field may result from word wrap rather than CRLFs Examples of specifying characters characters 3 to 5 of text of field "zip" character 1 of lastname chars 1 to 10 of text of recordfield \ "animal" of this page Examples of specifying words word 1 of namevar word 3 of script of button "Next" words 1 to 3 of text of field "preamble" Examples of specifying textlines textline 3 of text of field "address" textlines 1 to 3 of agreement textlines 1 to 5 of script of this book Specifying items * An item is zero or more characters separated by commas * An item can include any other characters, including CRLFs * A string that contains more than one item is commonly called a list More about lists * Lists are heavily used in OpenScript * Many properties of objects are lists: - position, bounds, or vertices - fillcolor, strokecolor - objects of a page or a group Examples of specifying items item 2 of objects of group "globe" item 5 of textline 3 of chessboard items 1 to 3 of text of field "laundry" Determining the limits of a string * If you don't know the upper limit of a range, use one of these functions: - charCount - wordCount - textLineCount - itemCountt Examples of string limitsunctions put chars 1 to charCount(ssn) set last to item itemCount(Entrants) step i from 1 to wordCount(giftlist) put textLineCount(text of field "dogs") Messages in detailf the language * You specify a message in a handler to identify the message to be handled * You specify a message as a parameter to the send or forward command to send that message explicitly Keyboard messages keyChar keyDown keyUp Parameters: key, isShift, isCtrl For keyChar, key is ANSI value For keyDown and keyUp, key is a key constant Book, page, background navigation enterBook leaveBook enterPage leavePage enterBackground leaveBackground enterSystem leaveSystem activateInstance Field and button navigation enterButton leaveButton enterField leaveField enterRecordField leaveRecordField Menu command messages * A menu command message is identical to its corresponding item on the menu except that spaces and ellipses are eliminated * Selected-object Properties commands and commands on the Control menu have no corresponding messages Object creation and deletion, etc. make remoteCommand destroy remoteGet remoteSet idle doHelp toggleStatus Message names own messagess * A message name should be unique and should not be an OpenScript keyword * The name should include only letters, numbers, and the underscore Defining your own messages * Decide on the message name * Write a handler for the message * Use the send or forward command to send the message so the handler can handle it Examples of valid message nameses restore makeItBlue 123Hike Values in OpenScriptriefly6 * A value is any piece of data * Values are not explicitly typed * ToolBook converts a value to the type needed for the current context Value References Simple references to values * A simple reference to a value can be: - A literal such as the number 27 - A constant such as null or blue - A container such as a variable, Functions * A function takes arguments and returns a value * OpenScript has many of the functions found in other languages plus some unique functions of its own * You can define your own functions Function syntax functionname(arg1, arg2, ...argN) Examples: - average(5,6,7,8) - sum(purchases) Arithmetic functions * Standard arithmetic, trig, log, and statistical functions * Financial functions annuityFactor and compoundFactor String and special functions ansiToChar itemCount charCount keyState charToAnsi menuState lowercase objectFromPoint offset textFromPoint textLineCount uppercase wordCountt Defining your own function` * Write a to get handler for the function * Put the handler in the script of a book or system book * Use your function in expressions just like a built-in function. Parts whereto buttonUp buttonUp whereto "A-list" buttonUp buttonDown rightButtonDown rightButtonUp buttonDown A-list buttonUp A-list rightButtonDown B-list rightButtonUp B-list Parts of the OpenScript language Parameters Parameters Statements Statements Commands Commands Expressions Expressions B-list Control Structures Control Structures Special Terms Special Terms Functions Functions Operators Operators Literals Literals Constants Constants A-list Script Script Handlers Handlers Object References Object References Messages Messages Value References Value References String Specifiers String Specifiers Containers Containers Variables Variables Properties Properties Command Window Command Window buttonUp buttonUp Dividing Line m"Dividing Line" buttonDown buttonUp buttonDown Dividing Line buttonUp Dividing Line Names you give to objects * You assign a name to an object by using a Properties menu command or by setting its name property * If a name includes spaces or special characters other than underscores, quotes are required; in other names quotes are optional but help script readability An object's "unique name" * A book's uniqueName property contains book plus the book's file name * Any other object's uniqueName property contains the object type plus the object's ID * ToolBook's unique name is system Objects on pages and backgrounds * If the object you're referring to is on the current page, you don't need to specify a location * If the object is on another page, specify the page: - button "Next" of page ID 5 - group "Caribou" of page "Alaska" Objects on backgrounds * If the object is on a background, you must specify its location even if it's on the background of the current page or you're working on the background: - button "Hint" of this background - group "Car" of background "Park" Objects in other books * If the object is in another book, add the book's name to the reference * If the book is in the current directory, you can omit its drive and directory: - page 5 of book "MAMMALS.TBK"""""""""""""""""""""""" Examples of unique names - button ID 5 - background ID 0 - book "c:\books\newmath.tbk"round ID 0 - book "c:\books\newmath.tbk" Examples of names you assign - field "helphint" - group "red car" - page "Alaska" ced exercise" Examples of objects in other books - page "Cats" of books "PETS.TBK" - background "Exercise" of book \ "C:\BOOKS\MATHBOOK.TBK" - group "Telephone" of page \ "Office Equipment" of book \ "D:\OFFICE\PLANS\FACILITIES.TBK""""""""""""" Object references - useful terms * Use this with page, background, or book to refer to the current page, background or book * Use my and self to refer to the object whose script is currently executing More useful terms in references * Use target to refer to the object that initially receives a message (as opposed to the one whose script is executing) * Use selection to refer to the currently selected object or objects Still more useful terms * Use focus to refer to the object that receives keyboard messages * Use parent to refer to the object next higher in the object hierarchy * Use objects to refer to the objects next lower in the object hierarchy Referring to record fields * To refer to a record field as an object, specify the background: - recordField "data" of this background * to refer to the text of a record field, specify the page: - text of recordField "data" of this page "Special terms" * "Special terms" is a loose category for OpenScript terms that are not commands, messages, properties, functions, constants, or operators * Where and how you use a special term depends on context Common special terms - a few examples * Ordinals: first through tenth * Relationals: first, last, middle, next, previous * Prepositions: of, by, after, before, * Articles (optional): a, an, the o f, by, the, after, before, into Mouse and pointer messages mouseEnter rightButtonDown mouseLeave rightButtonUp buttonDown rightButtonDoubleClick buttonStillDown buttonUp buttonDoubleClick Parameters: location, isShift, isCtrlShift, and isCtrl Control structures - special-purpose start spooler statements end spooler linkDLL dllname return type declarations end linkDLL Commands * Commands are the verbs of OpenScript * Almost every statement starts with a command * Most commands have parameterste the object to be acted upon or provides more detail Notes on command syntax * Capitalization is not required * Use \ to break up long statements * Use ; to continue short statements * Use -- to start a comment Types of commands * Data and object manipulation * Navigation * Script control * Variable declaration * User interface control * Menu control * File manipulation and printing * DDE, DLL, and data exchangeeeeeee Data and object commands draw, move, align select, select all, extend select, unselect show, hide set, get, put push, pop clear increment, decrement format return, sort, seed "So, where should I put a handler?"" * If a handler defines behavior unique to an object, put the handler in that object's script * If a handler defines more general behavior, put the handler in the script of an object higher in the hierarchy Variables Containers Variables Properties Command Window Declaring and using variables Parameters Parameters Expressions Special Terms Object References Messages A closer look at command parameters Containers Containers Variables Properties Command Window Referring to data in containersto arameters Parameterssameters * A command's parameters provide more detail for the command's action * Command parameters can be: - Expressions - Special terms - Object references - Messages ssages F l Command Window Properties Variables Control Structures Parameters Script Handlers Statements Commands Expressions Special Terms Object References Messages Value References Functions Operators String Specifiers Literals Constants Containers Parts parts buttonUp buttonUp parts Parts Script Control Structures Script Handlers Statements Commands Parameters Building scripts Expressions - in detail * An expression in OpenScript can consist of: - A simple reference to a value - A function with its parameters - Values combined with operators - A reference to part of a string * More details latere covered in more detail later specifiers Literals Literals - literally * A number * A string * If the string contains spaces or special characters, enclose it in quotes Constants Constants black CR null blue CRLF pi cyan formfeed quote green LF space magenta white yellow Expressions - brieflysss * An expression describes a value, character, or string in OpenScript * An expression can be: - Arithmetic (yields a value) - Logical (yields true or false) - String (yields a character string))gggggggggggggggggg Still more eventss * Making the window active * Receiving a DDE request from another application * Pressing F1 for help * Toggling the status box Where other messages get sent * Keyboard messages are sent to the current page at Reader level * Messages sent with the send command go to the object specified * All other messages are sent to the current page Then what? * If the object's script has a handler for the message, the handler runs * If not, the message "floats" up the object hierarchy * If it reaches the top (ToolBook, or "the system") default behavior results Default behavior for messages * For menu commands, default behavior is to carry out the command * For other messages, default behavior is to do nothing * You can write handlers to intercept and block default behavior for menu command messagesssssssss Messages: built-in or user-defined * All the messages mentioned so far are "built-in" to ToolBook * You can define your own messages: - Write a handler for the message - Send the message with the send commanddd The object hierarchy * All objects have a place in the object hierarchy * An object's position in the hierarchy affects how it receives messages Object IDs and names * An object ID is assigned to every object (except a book) when it is created * If you cut and paste an object, the pasted object gets a new ID * An object's ID is stored in its idNumber propertyy Object types book angledLine polygon page arc rectangle background curve roundedRectangle field ellipse recordField irregularPolygon button line hotword paintObject group pie polygon rectangle Managing message traffic * You can handle a message where it enters the hierarchy or let it "float up" * You can handle a message and forward it for more processing * You can send a message directly to an object t anywhere in the hierarchy Control structuresof processing * Control structures are common to most programming languages * You use control structures to alter the order in which statements are processed * OpenScript has five common and two special control structuresres How scripts are executed * A script consists of one or more handlers * Handlers are executed as needed, so they can be in any order * Statements within a handler are executed in order unless you use a control structure to alter processinggprocessinger of processing Compared to C, Basic, and Pascal OpenScript C Basic Pascal If/then/else If/else If/then If/then/else Step/by For For/next For/do While While While/do Do/until Do/while Repeal/until Conditions/when Switch/case Case/of Control structures - if/then/else if expression statements else statements end if Control structures - conditions/ conditions when expression1 statements when expression2 statements when expressionN statements else statements end conditions conditions when expression1 statements when expression2 statements when expressionN statements else statements end conditions Control structures - do/until, while statements until expression while expression statements end while Control structures - step/by step var from start to finish by steps statements end step Introduction to OpenScript :PRINTLAYOUT `D|D| `D|D| `D|D| `D|D| `D|D| `D|D| `D|D| `D|D| enterBook enterBook sizeToPage System "arrow" Select IrregularPolygon " Move the 6097, 4690 B"hotword2" 6097, 4105 /record B"button2" B"graphic2" 6127, 3535 B"group2" 5167, 2950 3877, 2545 3862, 2020 3862, 1540 4books" 3922, 1060 B"windows dlls" 3892, 565 B"System" 1897, 7000 B"hotword1" 1897, 4690 B"button1" B"graphic1" 1882, 3535 B"group1" 1867, 3070 3937, 2500 3922, 2020 3922, 1480 3922, 1090 B"Windows DLLs" 3907, 565 leavepage enterpage keychar buttonUp enterpage leavepage keychar buttonUp arrow arrow hotword2 field/record field button2 graphic2 group2 background system books windows dlls System background system books windows dlls system hotword2 field/record field button2 graphic2 group2 hotword1 field button1 graphic1 group1 background system books Windows DLLs System arrow selectall Background Background System books System books Windows DLLs Windows DLLs System The system (ToolBook) Field Field Group1 Group Hotword1 Hotword Button1 Button Graphic1 label Graphic Graphic Field/Record field Field/Record field Button2 Button Graphic2 label Graphic Graphic Group2 Group Hotword2 Hotword arrow Object referencessssssssssssss * An object reference starts with the object type * The object type is followed by the object's name or ID * Depending on context, you may need to supply information about the object's location Parts parts buttonUp buttonUp parts Parts Scripts * A script is a property of an object * Any object can have a script * Scripts are compiled automatically without explicit compiling or linkingggatically without explicit compiling or linking Handlers * A handler carries out a specific task * There are three kinds of handlers: - message handlers - to set handlers - to get handlerssslerss Parts parts buttonUp buttonUp parts Parts Getting Acquainted with OpenScript disclaimer IMPORTANT: These ToolBook files and Dynamic Link Library files are being made available free of charge exclusively for demonstration purposes to show some approaches programmers are taking for applications using ToolBook. The files have not undergone the rigorous review process which Asymetrix's commercial products undergo. Asymetrix does not intend to provide support for these files. Asymetrix specifically disclaims all warranties including without limitation all warranties of title or non-infringement, warranties of merchantability or fitness for a particular purpose and all other warranties express or implied. The files are made available "as is." ASYMETRIX SHALL NOT BE LIABLE FOR ANY DAMAGES INCLUDING BUT NOT LIMITED TO DIRECT, INDIRECT, INCIDENTAL, SPECIAL, COVER, RELIANCE, OR CONSEQUENTIAL DAMAGES ARISING FROM ITS MAKING THE FILES AVAILABLE, OR THE USE OR INABILITY TO USE THE FILES. ANY USE OF FILES IS STRICTLY AT YOUR OWN RISK. Copyright (c) 1990 by Asymetrix Corporation. All rights reserved. Asymetrix, ToolBook, and OpenScript are registered trademarks of Asymetrix Corporation. Message handlers * A message handler runs in response to a message * Syntax: to handle messagename statements end messagenameeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee To set and to get handlers * A to set handler is used to create a user-defined property for an object * A to get handler is used to create a user-defined function or to obtain the value of a user-defined property How messages work"handled" * A message is triggered by an event * The message is sent to an object * What happens then depends on the object's script Events that send messagessssssssss * Mouse clicks * Pointer movement * Keyboard activity * Book/page/background navigation More events that send messages * Menu commands * Object creation and deletion * The OpenScript send command * Doing nothing (theidle message) Where messages get sent * Mouse and pointer movement messages are sent to the object with the pointer at Reader level * Enter, leave, destroy, and make messages are sent to the related object lllllllllllllllllllllllllllllllllllllllllllllllllllllllllllllllllll "l ,b^aR