Skip to content

Commit 122a803

Browse files
author
livecodeali
committed
[[ Docs ]] Various fixes to resizeStack entry
- Fix some incorrect references - Rewrap at 72 characters - Remove references to deprecated liveResizing property
1 parent 64fbc11 commit 122a803

2 files changed

Lines changed: 37 additions & 13 deletions

File tree

docs/dictionary/message/resizeStack.lcdoc

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,41 @@ oldWidth: The stack's original width in pixels.
2828
oldHeight: The stack's original height in pixels.
2929

3030
Description:
31-
Handle the <resizeStack> <message> if you want to update the position of <object|objects> or do other tasks when the <stack window> changes size.
32-
33-
The <resizeStack> <message> is sent when the user resizes the <stack> by dragging its size box. It is also sent if a <handler> changes the size of the <stack> by changing its <properties> (<width>, <height>, and so on).
34-
35-
The <resizeStack> <message> is sent after the resizing is finished. This means that you cannot prevent a <stack|stack's> size from being changed by <trap|trapping> this <message>. If the <stack|stack's> <liveResizing> <property> is true, <resizeStack> <message|messages> are sent continuously during resizing, but you still cannot prevent resizing by trapping the <message>.
36-
37-
On Mac OS X systems when the <liveResizing> <property> is true and on all other systems, the <oldWidth> and <oldHeight> for each <resizeStack> <message> is the same as the <newWidth> and <newHeight> for the previous <resizeStack>. The <stack|stack's> original <width> and <height> are passed only with the first <resizeStack> <message> sent during a resize operation.
38-
39-
The screen is locked while a <resizeStack> <handler> is running, so it is not necessary to use the <lock screen> <command> to prevent changes from being seen. (However, the <lockScreen> <property> is not set to true.)
40-
41-
>*Note:* If the <stack's vScroll property> is nonzero, the amount of scroll is not included in the <newHeight> and <oldHeight>. This means that the <parameter|parameters> of the <resizeStack> < message(keyword)> are always equal to the <stack's height> before and after resizing, regardless of the <vScroll> setting.
42-
43-
References: maxWidth (property), width (property), height (property), minHeight (property), resizable (property), lockScreen (property), properties (property), vScroll (property), liveResizing (property), moveStack (message), resizeControl (message), unIconifyStack (message), revChangeWindowSize (command), lock screen (command), stack's vScroll property (object), stack's height (object), stack (object), object (glossary), property (glossary), current card (glossary), stack window (glossary), handler (glossary), message (glossary), parameter (glossary), command (glossary), trap (glossary)
31+
Handle the <resizeStack> <message> if you want to update the position of
32+
<object|objects> or do other tasks when the <stack window> changes size.
33+
34+
The <resizeStack> <message> is sent when the user resizes the <stack> by
35+
dragging its size box. It is also sent if a <handler> changes the size
36+
of the <stack> by changing its <properties> (<width>, <height>, and so
37+
on).
38+
39+
The <resizeStack> <message> is sent after the resizing is finished. This
40+
means that you cannot prevent a <stack|stack's> size from being changed
41+
by <trap|trapping> this <message>.
42+
43+
The <oldWidth> and <oldHeight> for each <resizeStack> <message> is the
44+
same as the <newWidth> and <newHeight> for the previous <resizeStack>.
45+
The <stack|stack's> original <width> and <height> are passed only with
46+
the first <resizeStack> <message> sent during a resize operation.
47+
48+
The screen is locked while a <resizeStack> <handler> is running, so it
49+
is not necessary to use the <lock screen> <command> to prevent changes
50+
from being seen. (However, the <lockScreen> <property> is not set to
51+
true.)
52+
53+
>*Note:* If the stack's <vScroll> property is nonzero, the amount of
54+
> scroll is not included in the <newHeight> and <oldHeight>. This means
55+
> that the <parameter|parameters> of the <resizeStack>
56+
> <message(keyword)> are always equal to the stack's <height> before and
57+
> after resizing, regardless of the <vScroll> setting.
58+
59+
References: maxWidth (property), width (property), height (property),
60+
minHeight (property), resizable (property), lockScreen (property),
61+
properties (property), vScroll (property), moveStack (message),
62+
resizeControl (message), unIconifyStack (message),
63+
revChangeWindowSize (command), lock screen (command), stack (object),
64+
object (glossary), property (glossary), current card (glossary),
65+
stack window (glossary), handler (glossary), message (glossary),
66+
parameter (glossary), command (glossary), trap (glossary)
4467

4568
Tags: windowing

docs/notes/bugfix-17971.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Fix formatting of resizeStack message docs entry

0 commit comments

Comments
 (0)