Skip to content

Commit aa0347a

Browse files
author
livecodeali
committed
[[ Header Bar ]] Document header bar messages
1 parent 4c72002 commit aa0347a

2 files changed

Lines changed: 43 additions & 0 deletions

File tree

extensions/widgets/header/header.lcb

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,45 @@ along with LiveCode. If not see <http://www.gnu.org/licenses/>. */
1717

1818
/*
1919
This widget is a header bar.
20+
21+
Name: headerAction
22+
Type: message
23+
Syntax: on headerAction <pName>
24+
25+
Summary: Sent when one of the <headerActions> icons is clicked.
26+
27+
Parameters:
28+
pName: The name of the header action that was clicked.
29+
30+
Description:
31+
Use the <headerAction> message to perform an action when one of the action icons is
32+
clicked by the user.
33+
34+
References: headerActions (property)
35+
36+
Name: leftAction
37+
Type: message
38+
Syntax: on leftAction
39+
40+
Summary: Sent when the <leftLabel> of the header bar is clicked.
41+
42+
Description:
43+
Use the leftAction message to perform an action when the label at the left hand side
44+
of the header bar is clicked.
45+
46+
References: leftLabel (property)
47+
48+
Name: searchAction
49+
Type: message
50+
Syntax: on searchAction
51+
52+
Summary: Sent when the search icon of the header bar is clicked.
53+
54+
Description:
55+
Use the searchAction message to perform an action when the search icon is clicked. Whether
56+
the search icon is visible or not is controlled by the <showSearchIcon> property.
57+
58+
References: showSearchIcon (property)
2059
*/
2160

2261
-- declaring the extension as a widget, followed by identifier
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Documentation
2+
The messages posted by the header bar widget have been documented.
3+
4+
# [15815] headerAction, leftAction and searchAction messages not documented.

0 commit comments

Comments
 (0)