Skip to content
This repository was archived by the owner on Aug 31, 2021. It is now read-only.

Commit 60dbba6

Browse files
committed
[[ Documentation ]] Fix a few issues with object docs entries
- Fix formatting - Add 'style' property references where appropriate - Remove lines detailing how to access list of associated properties which was only relevant to old dictionary stack
1 parent a73d5b0 commit 60dbba6

File tree

12 files changed

+197
-88
lines changed

12 files changed

+197
-88
lines changed

docs/dictionary/object/audioClip.lcdoc

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,28 @@ Example:
1818
play audioClip theCurrentSoundtrack
1919

2020
Description:
21-
Use the <audioClip> <object type> to play a sound that is stored in the <stack>, rather than in another file.
21+
Use the <audioClip> <object type> to play a sound that is stored in the
22+
<stack>, rather than in another file.
23+
24+
Unlike a player, an audio clip contains the sound that it plays. This
25+
increases the memory required by your stack, because the sound data is
26+
loaded into memory along with the rest of the stack whenever the stack
27+
file is open. However, it prevents the sound from being accidentally
28+
separated from the stack file and lost.
2229

23-
Unlike a player, an audio clip contains the sound that it plays. This increases the memory required by your stack, because the sound data is loaded into memory along with the rest of the stack whenever the stack file is open. However, it prevents the sound from being accidentally separated from the stack file and lost.
2430
Audio clips can be in WAV, AIFF, or AU format
2531

26-
An audio clip is contained in a stack. Audio clips cannot contain other objects. (An audio clip is not a control, since it has no user interface and cannot be owned by a <card>.)
32+
An audio clip is contained in a stack. Audio clips cannot contain other
33+
objects. (An audio clip is not a control, since it has no user interface
34+
and cannot be owned by a <card>.)
35+
36+
To play an audioClip, use the syntax
37+
38+
play audioClip <filename_of_audioclip>
39+
40+
To stop an audioClip, use the syntax
2741

28-
To play an audioClip, use the syntax "play audioClip &lt;filename_of_audioclip&gt;".
29-
To stop an audioClip, use the syntax "play stop".
42+
play stop
3043

31-
References: card (keyword), templateAudioClip (keyword), object type (glossary), stack (object)
44+
References: card (keyword), templateAudioClip (keyword),
45+
object type (glossary), stack (object)

docs/dictionary/object/button.lcdoc

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,27 @@ Example:
1919
if the number of this card is 1 then hide button "Previous"
2020

2121
Description:
22-
Use the <button> <object type> to create a clickable <button>, a <tabbed button|tabbed window>, or a <menu>.
22+
Use the <button> <object type> to create a clickable <button>, a
23+
<tabbed button|tabbed window>, or a <menu>.
2324

24-
Button objects can be push buttons, checkboxes, radio buttons, or menus, depending on the setting of their style <property>.
25+
Button objects can be push buttons, checkboxes, radio buttons, or
26+
menus, depending on the setting of their <style> <property>.
2527

26-
A button whose style is set to "menu" can be a <popup> or <contextual menu>, pulldown menu, option menu, <tabbed button>, or <combo box>, depending on the setting of its <menuMode> <property>.
28+
A button whose <style> is set to "menu" can be a <popup> or
29+
<contextual menu>, pulldown menu, option menu, <tabbed button>, or
30+
<combo box>, depending on the setting of its <menuMode> <property>.
2731

28-
A button is contained in a card, group, or background. Buttons cannot contain other objects.
32+
A button is contained in a card, group, or background. Buttons cannot
33+
contain other objects.
2934

30-
The button object has a number of properties and messages associated with it. To see a list of messages that can be sent to a button as a result of user actions or internal LiveCode events, open the "LiveCode Language Dictionary" page of the main Documentation window, ensure that the button column is visible and use sort and filter to bring the relevant entries to the top.
35+
>*Note:* A standard button is rendered by the operating system, not
36+
LiveCode. Changing certain properties of such a button will cause the
37+
button to stop honouring the native theme. Properties that affect the
38+
button's colour and border may cause this issue.
3139

32-
>*Note:* A standard button is rendered by the operating system, not LiveCode. Changing certain properties of such a button will cause the button to stop honouring the native theme. Properties that affect the button's colour and border may cause this issue.
33-
34-
References: templateButton (keyword), control (keyword), button (keyword), menu (keyword), menuMode (property), popup (command), property (glossary), tabbed button (glossary), contextual menu (glossary), object type (glossary), combo box (glossary)
40+
References: templateButton (keyword), control (keyword),
41+
button (keyword), menu (keyword), menuMode (property), popup (command),
42+
property (glossary), tabbed button (glossary), style (property),
43+
contextual menu (glossary), object type (glossary), combo box (glossary)
3544

3645
Tags: objects

docs/dictionary/object/card.lcdoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,15 @@ Example:
2121
set the marked of this card to true
2222

2323
Description:
24-
Use the <card> <object type> to display different sets of <control|controls> in the same <stack window>.
24+
Use the <card> <object type> to display different sets of
25+
<control|controls> in the same <stack window>.
2526

26-
A card corresponds to a single page of a stack: one card of each stack can be seen at a time. Each stack contains one or more cards.
27+
A card corresponds to a single page of a stack: one card of each stack
28+
can be seen at a time. Each stack contains one or more cards.
2729

2830
Cards are contained in stacks, and may contain any kind of control.
2931

30-
The card object has a number of properties and messages associated with it. To see a list of messages that can be sent to a card as a result of user actions or internal LiveCode events, open the "LiveCode Language Dictionary" page of the main Documentation window, and choose "Card Messages" from the Show menu at the top. To see a list of all the properties a card can have, choose "Card Properties" from the Show menu.
31-
32-
References: templateCard (keyword), stack window (glossary), object type (glossary), stack (object), control (object)
32+
References: templateCard (keyword), stack window (glossary),
33+
object type (glossary), stack (object), control (object)
3334

3435
Tags: objects

docs/dictionary/object/field.lcdoc

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,18 @@ Example:
2121
put it into line 3 of field "Help"
2222

2323
Description:
24-
Use the <field> <object type> to hold text or to provide a place for the user to enter text.
24+
Use the <field> <object type> to hold text or to provide a place for the
25+
user to enter text.
2526

26-
Fields can contain styled text (with different fonts, sizes, styles, and colors for different parts of the text they contain). A field can be displayed with or without horizontal and vertical scrollbars, and can be unlocked (allowing the user to enter text) or locked.
27+
Fields can contain styled text (with different fonts, sizes, styles, and
28+
colors for different parts of the text they contain). A field can be
29+
displayed with or without horizontal and vertical scrollbars, and can be
30+
unlocked (allowing the user to enter text) or locked.
2731

28-
A field is contained in a card, group, or background. Fields cannot contain other objects.
32+
A field is contained in a card, group, or background. Fields cannot
33+
contain other objects.
2934

30-
The field object has a number of properties and messages associated with it. To see a list of messages that can be sent to a field as a result of user actions or internal LiveCode events, open the "LiveCode Language Dictionary" page of the main Documentation window, ensure that the field column is visible and use sort and filter to bring the relevant entries to the top
31-
32-
References: templateField (keyword), control (keyword), object type (glossary)
35+
References: templateField (keyword), control (keyword),
36+
object type (glossary)
3337

3438
Tags: objects

docs/dictionary/object/graphic.lcdoc

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,21 @@ Example:
2121
move graphic "Arrow" to 45,104 in 3 seconds
2222

2323
Description:
24-
Use the <graphic> <object type> to create a geometric shape, a straight or broken line, an arrow, or other shape.
25-
26-
Graphics can be circles, ovals, arcs, squares, rectangles, regular polygons with any number of sides, irregular polygons (closed or open), lines (jagged or straight), or curves (smooth or broken). You specify a graphic's basic shape by setting its style <property>, and details of different basic shapes with the <points>, <arcAngle>, <startAngle>, <angle>, and <polySides> <properties>.
27-
28-
Unlike an image, a graphic can be resized without losing detail or becoming "jagged".
29-
A graphic is contained in a card, group, or background. Graphics cannot contain other objects.
30-
The graphic object has a number of properties and messages associated with it. To see a list of messages that can be sent to a graphic as a result of user actions or internal LiveCode events, open the "Dictionary" page of the main Documentation window, ensure that the graphic column is visible and use sort and filter to bring the relevant entries to the top
31-
32-
References: startAngle (property), angle (property), editMode (property), points (property), arcAngle (property), properties (property), polySides (property), control (keyword), image (object), property (glossary), object type (glossary)
24+
Use the <graphic> <object type> to create a geometric shape, a straight
25+
or broken line, an arrow, or other shape.
26+
27+
Graphics can be circles, ovals, arcs, squares, rectangles, regular
28+
polygons with any number of sides, irregular polygons (closed or open),
29+
lines (jagged or straight), or curves (smooth or broken). You specify a
30+
graphic's basic shape by setting its style <property>, and details of
31+
different basic shapes with the <points>, <arcAngle>, <startAngle>,
32+
<angle>, and <polySides> <properties>. Unlike an image, a graphic can be
33+
resized without losing detail or becoming "jagged".
34+
35+
A graphic is contained in a card, group, or background. Graphics cannot
36+
contain other objects.
37+
38+
References: startAngle (property), angle (property),
39+
editMode (property), points (property), arcAngle (property),
40+
properties (property), polySides (property), control (keyword),
41+
image (object), property (glossary), object type (glossary)

docs/dictionary/object/group.lcdoc

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,27 @@ Example:
2121
create group "Options"
2222

2323
Description:
24-
Use the <group> <object type> to hold sets of <control|controls>, <radio button|radio-button clusters>, <menu bar|menu bars>, and <control|controls> to be displayed on more than one <card>.
24+
Use the <group> <object type> to hold sets of <control|controls>,
25+
<radio button|radio-button clusters>, <menu bar|menu bars>, and
26+
<control|controls> to be displayed on more than one <card>.
2527

26-
A group is a set of controls that has been made into a single control. You can select, move, resize, or copy the group, and all the controls in it come with the group. You can show a border around the group (using its border <property>), a label (using the <showName> <property>), or <scrollbar|scrollbars>.
28+
A group is a set of controls that has been made into a single control.
29+
You can select, move, resize, or copy the group, and all the controls in
30+
it come with the group. You can show a border around the group (using
31+
its border <property>), a label (using the <showName> <property>), or
32+
<scrollbar|scrollbars>.
2733

2834
Groups can contain any type of control (including other nested groups).
2935

30-
When referring to a group using the synonyms background, bkgnd, or bg, the reference is to one among the groups in a stack, rather than to one among the groups on a card. For example, the object reference background 1 indicates the first group in the current stack, not the lowest-layered group on the current card.
36+
When referring to a group using the synonyms background, bkgnd, or bg,
37+
the reference is to one among the groups in a stack, rather than to one
38+
among the groups on a card. For example, the object reference background
39+
1 indicates the first group in the current stack, not the lowest-layered
40+
group on the current card.
3141

32-
The group object has a number of properties and messages associated with it. To see a list of messages that can be sent to a group as a result of user actions or internal LiveCode events, open the "LiveCode Language Dictionary" page of the main Documentation window, ensure that the group column is visible and use sort and filter to bring the relevant entries to the top
33-
34-
References: card (keyword), control (keyword), templateGroup (keyword), showName (property), scrollbar (object), control (object), property (glossary), radio button (glossary), menu bar (glossary), object type (glossary)
42+
References: card (keyword), control (keyword), templateGroup (keyword),
43+
showName (property), scrollbar (object), control (object),
44+
property (glossary), radio button (glossary), menu bar (glossary),
45+
object type (glossary)
3546

3647
Tags: objects

docs/dictionary/object/image.lcdoc

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,23 @@ Example:
2121
export image ID 9234 to file "Test Image.jpg"
2222

2323
Description:
24-
Use the <image> <object type> to hold photographs, icons, and decorative elements, and to allow the user to paint.
24+
Use the <image> <object type> to hold photographs, icons, and decorative
25+
elements, and to allow the user to paint.
2526

26-
Each image contains a bitmapped picture, which can either be imported with the import <command> or created using the <paint tool|paint tools>. An <image(keyword)> can display either its own data, or a <file> specified by the <image(object)|image's> <filename> <property>.
27+
Each image contains a bitmapped picture, which can either be imported
28+
with the import <command> or created using the <paint tool|paint tools>.
29+
An <image(keyword)> can display either its own data, or a <file>
30+
specified by the <image(object)|image's> <filename> <property>.
2731

28-
An image is contained in a card, group, or background. Images cannot contain other objects.
29-
30-
The image object has a number of properties and messages associated with it. To see a list of messages that can be sent to an image as a result of user actions or internal LiveCode events, open the "LiveCode Language Dictionary" page of the main Documentation window, ensure that the image column is visible and use sort and filter to bring the relevant entries to the top
32+
An image is contained in a card, group, or background. Images cannot
33+
contain other objects.
3134

3235
>*Note:* Animated GIFs cannot be resized in LiveCode.
3336

34-
References: filename (property), imageData (property), resizeQuality (property), templateImage (keyword), file (keyword), image (keyword), control (keyword), image (object), graphic (object), property (glossary), paint tool (glossary), bitmap (glossary), command (glossary), object type (glossary)
37+
References: filename (property), imageData (property),
38+
resizeQuality (property), templateImage (keyword), file (keyword),
39+
image (keyword), control (keyword), image (object), graphic (object),
40+
property (glossary), paint tool (glossary), bitmap (glossary),
41+
command (glossary), object type (glossary)
3542

3643
Tags: objects

docs/dictionary/object/player.lcdoc

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,34 @@ Example:
1919
hide player (the selectedText of button "Current Movie")
2020

2121
Description:
22-
Use the <player> <object type> to display a movie or sound from a separate <file>.
23-
24-
Unlike an audio clip or video clip, a player does not contain the movie or sound data. Instead, you use the player's filename <property> to indicate the separate <file> that holds the movie or sound. This reduces the memory required by your <stack>, because the movie or sound data is only <loaded into memory> when it's being used, rather than being <loaded into memory> whenever the <stack file> is open. However, it also makes it possible for the movie or sound data to be misplaced during distribution, since the <file> is separate from your <stack file>.
25-
26-
A player is contained in a card, group, or background. Players cannot contain other objects.
27-
28-
The player object has a number of properties and messages associated with it. To see a list of messages that can be sent to a player as a result of user actions or internal LiveCode events, open the "LiveCode Language Dictionary" page of the main Documentation window, ensure that the player column is visible and use sort and filter to bring the relevant entries to the top.
29-
30-
>*Important:* Setting a <player|player's> filename does not automatically update its <currentTime> <property>. If you play a <movie|movie file>, then change the <player|player's> <filename> in order to play another, you must reset the <currentTime> to zero in order to start from the beginning of the second <movie> :
31-
32-
set the filename of player "My Player" to "SecondMovie.mov"
33-
set the currentTime of player "My Player" to zero
34-
35-
References: templatePlayer (keyword), control (keyword), file (keyword), filename (property), currentTime (property), qtIdleRate (property), stack (object), player (object), property (glossary), stack file (glossary), movie (glossary), loaded into memory (glossary), object type (glossary), movie (function)
22+
Use the <player> <object type> to display a movie or sound from a
23+
separate <file>.
24+
25+
Unlike an audio clip or video clip, a player does not contain the movie
26+
or sound data. Instead, you use the player's filename <property> to
27+
indicate the separate <file> that holds the movie or sound. This reduces
28+
the memory required by your <stack>, because the movie or sound data is
29+
only <loaded into memory> when it's being used, rather than being
30+
<loaded into memory> whenever the <stack file> is open. However, it also
31+
makes it possible for the movie or sound data to be misplaced during
32+
distribution, since the <file> is separate from your <stack file>.
33+
34+
A player is contained in a card, group, or background. Players cannot
35+
contain other objects.
36+
37+
>*Important:* Setting a <player|player's> filename does not
38+
automatically update its <currentTime> <property>. If you play a
39+
<movie|movie file>, then change the <player|player's> <filename> in
40+
order to play another, you must reset the <currentTime> to zero in order
41+
to start from the beginning of the second <movie> :
42+
43+
set the filename of player "My Player" to "SecondMovie.mov"
44+
set the currentTime of player "My Player" to zero
45+
46+
References: templatePlayer (keyword), control (keyword), file (keyword),
47+
filename (property), currentTime (property), qtIdleRate (property),
48+
stack (object), player (object), property (glossary),
49+
stack file (glossary), movie (glossary), loaded into memory (glossary),
50+
object type (glossary), movie (function)
3651

3752
Tags: objects

docs/dictionary/object/scrollbar.lcdoc

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,20 @@ Example:
2121
if the thumbPosition of scrollbar "Level" &gt; 400 then doOverflow
2222

2323
Description:
24-
Use the <scrollbar> <object type> to display the current level or the progress of a task, or to let the user set a level or amount.
24+
Use the <scrollbar> <object type> to display the current level or the
25+
progress of a task, or to let the user set a level or amount.
2526

26-
A scrollbar can be displayed as a standard scroll bar, a progress bar, or a sliding control, depending on the setting of the scrollbar's style <property>. <scrollbar|Scrollbars> can be vertical or horizontal, depending on whether their <height> or <width> is greater.
27+
A scrollbar can be displayed as a standard scroll bar, a progress bar,
28+
or a sliding control, depending on the setting of the scrollbar's
29+
<style> <property>. <scrollbar|Scrollbars> can be vertical or
30+
horizontal, depending on whether their <height> or <width> is greater.
2731

28-
A scrollbar is contained in a card, group, or background. Scrollbars cannot contain other objects.
32+
A scrollbar is contained in a card, group, or background. Scrollbars
33+
cannot contain other objects.
2934

30-
The scrollbar object has a number of properties and messages associated with it. To see a list of messages that can be sent to a scrollbar as a result of user actions or internal LiveCode events, open the "LiveCode Language Dictionary" page of the main Documentation window, ensure that the scrollbar column is visible and use sort and filter to bring the relevant entries to the top
31-
32-
References: templateScrollbar (keyword), control (keyword), height (property), width (property), scrollbarDrag (message), scrollbar (object), property (glossary), object type (glossary)
35+
References: templateScrollbar (keyword), control (keyword),
36+
height (property), width (property), scrollbarDrag (message),
37+
scrollbar (object), property (glossary), object type (glossary),
38+
style (property)
3339

3440
Tags: objects

0 commit comments

Comments
 (0)