Skip to content
This repository was archived by the owner on Aug 31, 2021. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/dictionary/command/print-link.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,24 +30,24 @@ Description:
Use the print link command to define a hyperlink within a pdf printing
loop.

If the url adjective is specified, then <link> is interpreted as a URL
If the url adjective is specified, then *linkName* is interpreted as a URL
and an external URL launching link is created in the PDF document. The
given rectangle jumps to that URL when it is clicked.

If the anchor adjective is specified, then <link> is interpreted as an
If the anchor adjective is specified, then *linkName* is interpreted as an
internal anchor name, as specified by the print anchor command, and an
internal anchor link is created in the PDF document. Clicking the given
rectangle jumps to that anchor.

If no adjective is specified then <link> is interpreted as a URL if it
If no adjective is specified then *linkName* is interpreted as a URL if it
begins with (ASCII) letters followed by a colon. e.g. "mailto:foobar" is
interpreted as a URL, whereas "mail-to-anchor:foo" is interpreted as an
anchor name.

When printing fields, any text that has its <linkText> property set
together with the link <textStyle> is treated as if a print link command
had been executed with the contents of the property as <link>, and the
<formattedRect> of the text as <rectangle>.
had been executed with the contents of the property as *linkName*, and the
<formattedRect> of the text as *rectArea*.

References: print bookmark (command), print anchor (command),
open printing to pdf (command), cancel printing (command),
Expand Down
5 changes: 3 additions & 2 deletions docs/dictionary/command/put.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,15 @@ The result:
>*Important:* If writing to a url container fails, an error is returned
> in the result. For example:

<put> the result into tResult.
local tResult
<put> the result into tResult

> *Note:* Unlike its use with the <file> and <binfile URL> types, the
> <put> <command>, when used with a <resfile>, does not create the <file>
> if it doesn't exist. Instead, an error message is returned in the
> <result>. To create a file, first use a statement like the following:

<open file> tFilepath
open file tFilepath

> When used with an ftp <URL>, <upload|uploads> the <value> to an
> <FTP> <server>. If an error occurs during uploading, the
Expand Down
3 changes: 3 additions & 0 deletions docs/dictionary/command/rename.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ on the same volume.
> rename or move <files> and <folders> it didn't create without
> obtaining explicit confirmation from the user.

>*Warning:* If a file with the same file path as the newPath already exists,
> that file will be overwritten without confirmation.

Changes:
The ability to move a file or folder on Mac OS and Windows systems with
the rename command was introduced in version 1.1.1. In previous
Expand Down
9 changes: 5 additions & 4 deletions docs/dictionary/command/reply.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Syntax: reply error <string>

Summary:
<return|Returns> data to an application that sent LiveCode an
<Apple event>.
<Apple Event>.

Introduced: 1.0

Expand Down Expand Up @@ -65,9 +65,10 @@ is equivalent to
reply string with keyword "errs"


For more information about Apple events, see Apple Computer's technical
documentation, Inside Macintosh: Interapplication Communication, located
at http://developer.apple.com/techpubs/mac/IAC/IAC-2.html.
For more information about Apple events, refer to the section entitled
"Apple Events Sent by the Mac OS" in the technical documentation section
located on [Apple's website]
(http://developer.apple.com/documentation/coreservices/apple_events).

References: send to program (command), return (constant),
Apple Event (glossary), command (glossary), return (glossary),
Expand Down
4 changes: 2 additions & 2 deletions docs/dictionary/command/request-appleEvent.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Type: command
Syntax: request appleEvent {class|ID|sender|returnID|data [with keyword <aeKey>]}

Summary:
Gets data about an <Apple event> that was sent to LiveCode.
Gets data about an <Apple Event> that was sent to LiveCode.

Introduced: 1.0

Expand Down Expand Up @@ -73,7 +73,7 @@ specify which pieces you want to get.
For more information about Apple events, refer to the section entitled
"Apple Events Sent by the Mac OS" in the technical documentation section
located on [Apple's website]
(https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/ScriptableCocoaApplications/SApps_handle_AEs/SAppsHandleAEs.html#//apple_ref/doc/uid/20001239-1117769).
(https://developer.apple.com/documentation/coreservices/apple_events).

References: send to program (command), handler (glossary),
Apple Event (glossary), variable (glossary), command (glossary),
Expand Down
19 changes: 10 additions & 9 deletions docs/dictionary/command/request.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Type: command
Syntax: request <expression> {of | from} {program | application} <programAddress>

Summary:
The <request> data gets information from another application via <Apple
Event|Apple events>.
The <request> data gets information from another application via
<Apple Event|Apple Events>.

Introduced: 1.0

Expand Down Expand Up @@ -34,10 +34,10 @@ omit the zone. If the other program is running on the same computer, you
can omit both the zone and the computer name.

It:
If the program supports this <Apple event>, it evaluates the expression
If the program supports this <Apple Event>, it evaluates the expression
and sends the result back to LiveCode, which places it in the <it>
<variable>. The <request> <command> sends aneval <Apple event> to the
<programAddress>. If the program supports this <Apple event>, it
<variable>. The <request> <command> sends aneval <Apple Event> to the
<programAddress>. If the program supports this <Apple Event>, it
evaluates the expression and sends the result back to LiveCode, which
places it in the <it> <variable>.

Expand All @@ -49,11 +49,12 @@ the result <function>.

Description:
Use the <request> <command> to obtain data from another application via
the eval <Apple event>.
the eval <Apple Event>.

For more information about Apple events, see Apple Computer's technical
documentation, Inside Macintosh: Interapplication Communication, located
at [Apple's developer site](https://developer.apple.com/library/archive/documentation/mac/IAC/IAC-2.html)
For more information about Apple events, refer to the section entitled
"Apple Events Sent by the Mac OS" in the technical documentation section
located on [Apple's website]
(https://developer.apple.com/documentation/coreservices/apple_events).

References: send to program (command), function (control structure),
command (glossary), variable (glossary), Apple Event (glossary),
Expand Down
24 changes: 12 additions & 12 deletions docs/dictionary/command/revExecuteSQL.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@ was opened.

SQLStatement (string):
A string in Structured Query Language. (Do not include a semicolon at
the end of the SQLStatement.) >*Note:* Some database systems, such as
Oracle, are capable of handling a multiple-line SQL statement.
the end of the SQLStatement.)
> *Note:* Some database systems, such as
> Oracle, are capable of handling a multiple-line SQL statement.

variablesList:
The variablesList consists of one or more variable names (or expressions
Expand All @@ -41,9 +42,10 @@ name may also be the name of an array element, for example

arrayName (array):
The name of a single array variable whose keys are sequential
numbers.>*Note:* The variable names or arrayName must be enclosed in
quotes; otherwise, the variable's value rather than its name is passed
to the revExecuteSQL command.
numbers.
> *Note:* The variable names or arrayName must be enclosed in
> quotes; otherwise, the variable's value rather than its name is passed
> to the revExecuteSQL command.


The result:
Expand All @@ -66,8 +68,7 @@ each of these placeholders. For example, if you have two
<variable|variables> called "valueX" and "valueY", you can use a
<SQLStatement> that includes placeholders as follows:

revExecuteSQL myID, "insert into mytable values(:1,:2,:1)", "valueX"
,"valueY"
revExecuteSQL myID, "insert into mytable values(:1,:2,:1)", "valueX","valueY"

The content of the variable valueX is substituted for the ":1" in the
SQLQuery (in both places where ":1" appears), and the content of valueY
Expand All @@ -78,17 +79,16 @@ is substituted for ":2".
> syntax error to be returned by the database because a placeholder is
> being used to represent a column name (:1).

-- Invalid, will cause SQL syntax error
revExecuteSQL myID,
"insert into mytable(:1, name, date) values (:2, :3, :2)",
"tColumnName", "tValueX", "tValueY"
-- Invalid, will cause SQL syntax error
revExecuteSQL myID,
"insert into mytable(:1, name, date) values (:2, :3, :2)", "tColumnName", "tValueX", "tValueY"

If you specify an <arrayName> rather than a list of ordinary
<variable|variables>, the <revExecuteSQL> <command> substitutes the
corresponding <element> of the <array> for each of the placeholders in
the query:

revExecuteSQL myID,"insert into mytable values(:1,:2,:1)","myArray"
revExecuteSQL myID,"insert into mytable values(:1,:2,:1)","myArray"

The content of the element myArray[1] is substituted for the ":1" in the
SQLQuery (in both places where ":1" appears), and the content of
Expand Down
10 changes: 5 additions & 5 deletions docs/dictionary/command/revInitializeVideoGrabber.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ To use <VFW|Video for Windows> (on <Windows|Windows systems>), specify
"VFW".

To close the window and unload the video capture code, you should use
the <revCloseVideoGrabber> <command> when you're done with <video
capture>.
the <revCloseVideoGrabber> <command> when you're done with
<video capture>.

>*Important:* The <revInitializeVideoGrabber> <command> is part of the
> <Video library>. To ensure that the <command> works in a
Expand All @@ -87,9 +87,9 @@ revStopPreviewingVideo (command), stack window (glossary),
video capture (glossary), Windows (glossary), VFW (glossary),
Standalone Application Settings (glossary), video grabber (glossary),
standalone application (glossary), function (glossary),
command (glossary), LiveCode custom library (glossary), file (keyword),
Video library (library), properties (property), dontUseQT (property),
dontUseQTEffects (property)
command (glossary), LiveCode custom library (glossary),
QuickTime (glossary), file (keyword), Video library (library),
properties (property), dontUseQT (property), dontUseQTEffects (property)

Tags: multimedia

41 changes: 20 additions & 21 deletions docs/dictionary/command/revMail.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,18 @@ messageBody (string):
This text appears in the 'body' of the email message.

The result:
On return on iOS, the result is set to one of:. On return on Android,
the result is set to:. * unknown - On Android the email activity does
not return its status back to the calling activity so the result is set
to 'unknown' in all cases.
On return on iOS, the result is set to one of:
* not configured - if the user has turned off or has not setup mail
access on their device
* cancel - if the user chooses to cancel the send
* saved - if the user chose to save the message in drafts
* sent - if the user elected to send the email
* failed - if sending the email was attempted, but it failed

On return on Android, the result is set to:
* unknown - On Android the email activity does not return its status
back to the calling activity so the result is set to 'unknown' in all
cases.

Description:
Use the <revMail> <command> to create an email message from within a
Expand All @@ -54,8 +62,8 @@ Use the <revMail> <command> to create an email message from within a
When LiveCode executes the <revMail> <command>, the user's email program
is opened (if necessary) and a new email message with the specified
<parameter|parameters> is created. The user can change any of the
settings before sending the message, and the message is not sent
automatically: the user must explicitly send it (for example, by
settings before sending the message, and the message is not
sent automatically: the user must explicitly send it (for example, by
clicking a 'Mail' button in the email program).

On Mac OS systems, the mail message is opened in the application the
Expand All @@ -64,14 +72,6 @@ user has set for the 'mailto:' protocol in the Internet control panel

On iOS, <revMail> hooks into the iOS MessageUI framework.

* not configured - if the user has turned off or has not setup mail
access on their device
* cancel - if the user chooses to cancel the send
* saved - if the user chose to save the message in drafts
* sent - if the user elected to send the email
* failed - if sending the email was attempted, but it failed


>*Important:* On <Mac OS|Mac OS systems>, the <revMail> <command>
> requires that AppleScript be installed and that the GURL <Apple Event>
> be supported. GURL support is included in <Mac OS> 8.5 or later, and
Expand All @@ -86,9 +86,9 @@ For some older email programs, it may not be possible to specify a
<command> still works with such programs, but only the 'To:' header is
set.

>*Note:* When included in a <standalone application>, the <Common
> library> is implemented as a hidden <group> and made available when
> the <group> receives its first <openBackground> message. During the
>*Note:* When included in a <standalone application>, the
> <Common library> is implemented as a hidden <group> and made available
> when the <group> receives its first <openBackground> message. During the
> first part of the <application|application's> startup process, before
> this <message> is sent, the <revMail> <command> is not yet available.
> This may affect attempts to use this <command> in <startup>,
Expand All @@ -107,10 +107,9 @@ mobileComposeHtmlMail (command), parameter (glossary),
main stack (glossary), handler (glossary), message (glossary),
group (glossary), Mac OS (glossary), standalone application (glossary),
Apple Event (glossary), command (glossary), application (glossary),
file (keyword), revMail (library), Common library (library),
library (library), startup (message), openBackground (message),
preOpenStack (message), openStack (message), preOpenCard (message),
stack (object)
file (keyword), Common library (library), library (library),
startup (message), openBackground (message), preOpenStack (message),
openStack (message), preOpenCard (message), stack (object)

Tags: networking

18 changes: 8 additions & 10 deletions docs/dictionary/command/revPrintReport.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ Type: command
Syntax: revPrintReport

Summary:
Prints a report from the <report viewer|report viewers> on the
<current card>.
Prints a report from the report viewers on the <current card>.

Introduced: 2.0

Expand All @@ -21,22 +20,21 @@ revPrintReport

Description:
Use the <revPrintReport> <command> to print a report that you have set
up in the <Report Builder>.
up in the Report Builder.

>*Note:* The <Report Builder> stack is no-longer supported but can
> still
> be used by manually launching the tool.
>*Note:* The Report Builder stack is no-longer supported but can
> still be used by manually launching the tool.

When you use the <Report Builder> to create a set of report settings,
When you use the Report Builder to create a set of report settings,
the settings are stored with the card. The <revPrintReport> <command>
uses the settings specified in the <Report Builder> for the
uses the settings specified in the Report Builder for the
<current card> to print the report. If you have never used the
<Report Builder> with the <current card> (and therefore there are no
Report Builder with the <current card> (and therefore there are no
report settings to use), the <revPrintReport> <command> causes a
<error|script error>.

The <revPrintReport> <command> is equivalent to clicking "Print Report"
in the <Report Builder>.
in the Report Builder.

>*Important:* The <revPrintReport> <command> is part of the
> <Printing library>. To ensure that the <command> works in a
Expand Down
9 changes: 5 additions & 4 deletions docs/dictionary/command/revShowPrintDialog.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,11 @@ printing options only for the currently <execute|executing> <handler>.

References: answer printer (command), revPrintText (command),
group (command), revPrintField (command), answer page setup (command),
application (glossary), standalone application (glossary),
dialog box (glossary), execute (glossary), command (glossary),
Windows (glossary), main stack (glossary), OS X (glossary),
result (glossary), Standalone Application Settings (glossary),
result (function), application (glossary),
standalone application (glossary), dialog box (glossary),
execute (glossary), command (glossary), Windows (glossary),
main stack (glossary), OS X (glossary),
Standalone Application Settings (glossary),
Mac OS (glossary), message (glossary), parameter (glossary),
handler (glossary), LiveCode custom library (glossary),
Printing library (library), startup (message), openBackground (message),
Expand Down
Loading