24 |
One line may not exceed 1024 bytes, including newline. |
One line may not exceed 1024 bytes, including newline. |
25 |
|
|
26 |
The protocol has no concept of hidden or unmapped windows. A window does not |
The protocol has no concept of hidden or unmapped windows. A window does not |
27 |
exist unless it is visible. Note that a minimised window is an exception to |
exist unless it is visible. Note that a minimized window is an exception to |
28 |
this rule. |
this rule. |
29 |
|
|
30 |
Data types |
Data types |
36 |
|
|
37 |
All integers fit inside 32 bits. |
All integers fit inside 32 bits. |
38 |
|
|
39 |
|
Strings are sent in UTF-8 and do not contain any characters less than 0x20 or |
40 |
|
the character , (comma). |
41 |
|
|
42 |
Server to Client Operations |
Server to Client Operations |
43 |
=========================== |
=========================== |
44 |
|
|
45 |
CREATE1 |
CREATE |
46 |
------- |
------ |
47 |
|
|
48 |
Allocate structures for a new window. |
Allocate structures for a new window. |
49 |
|
|
50 |
Syntax: |
Syntax: |
51 |
CREATE1,<ID>,<FLAGS> |
CREATE,<ID>,<PARENT>,<FLAGS> |
52 |
|
|
53 |
|
Indicates that a window has appeared on the server. If PARENT is non-zero then |
54 |
|
the new window is a child of that window (it's transient for it). The special |
55 |
|
value 0xFFFFFFFF for PARENT means that the window is a popup window without a |
56 |
|
parent. It's commonly used for splash screens, tool tips and context menus. |
57 |
|
|
58 |
Note that very little information is included in this message. Things like |
Note that very little information is included in this message. Things like |
59 |
title and state will come in subsequent messages. This message should only |
title and state will come in subsequent messages. This message should only |
60 |
be used to allocate data structures for the new window. |
be used to allocate data structures for the new window. |
61 |
|
|
62 |
DESTROY1 |
DESTROY |
63 |
-------- |
------- |
64 |
|
|
65 |
Remove a window. |
Remove a window. |
66 |
|
|
67 |
Syntax: |
Syntax: |
68 |
DESTROY1,<ID>,<FLAGS> |
DESTROY,<ID>,<FLAGS> |
69 |
|
|
70 |
Remove the window and deallocate all associated structures. |
Remove the window and deallocate all associated structures. |
71 |
|
|
72 |
POSITION1 |
POSITION |
73 |
--------- |
-------- |
74 |
|
|
75 |
Move a window. |
Move and/or resize a window. |
76 |
|
|
77 |
Syntax: |
Syntax: |
78 |
POSITION1,<ID>,<X>,<Y>,<WIDTH>,<HEIGHT>,<FLAGS> |
POSITION,<ID>,<X>,<Y>,<WIDTH>,<HEIGHT>,<FLAGS> |
79 |
|
|
80 |
Move and/or resize a window. If the window isn't visible yet (because a |
If the window isn't visible yet (because a |
81 |
SETSTATE1 hasn't been set or because it's minimised), you must store the |
STATE hasn't been set or because it's minimized), you must store the position |
82 |
position and size. A new POSITION1 is not guaranteed to be sent when the |
and size. A new POSITION is not guaranteed to be sent when the window changes |
83 |
window changes state. |
state. |
84 |
|
|
85 |
|
TITLE |
86 |
|
----- |
87 |
|
|
88 |
ZCHANGE1 |
Sets a window title. |
89 |
-------- |
|
90 |
|
Syntax: |
91 |
|
TITLE,<ID>,<TITLE>,<FLAGS> |
92 |
|
|
93 |
|
The text is guaranteed to be stripped of control characters (< 0x20). |
94 |
|
|
95 |
|
Note that this has the same requirement as POSITION, that the title needs to |
96 |
|
be stored for newly created windows until a STATE is sent. It is however not |
97 |
|
guaranteed that a TITLE will be sent before the first STATE. |
98 |
|
|
99 |
|
|
100 |
|
ZCHANGE |
101 |
|
------- |
102 |
|
|
103 |
The window moved in z order. |
The window moved in z order. |
104 |
|
|
105 |
Syntax: |
Syntax: |
106 |
ZCHANGE1,<ID>,<BEHIND>,<FLAGS> |
ZCHANGE,<ID>,<BEHIND>,<FLAGS> |
107 |
|
|
108 |
The window with the id ID is behind the window with the id BEHIND. If |
The window with the id ID is behind the window with the id BEHIND. If |
109 |
BEHIND is 0, then this window should be brought to the front. |
BEHIND is 0, then this window should be brought to the front. |
110 |
|
|
111 |
SETSTATE1 |
STATE |
112 |
--------- |
----- |
113 |
|
|
114 |
Changes the window's state and/or title. |
Changes the window's state and/or title. |
115 |
|
|
116 |
Syntax: |
Syntax: |
117 |
SETSTATE1,<ID>,<TITLE>,<STATE>,<FLAGS> |
STATE,<ID>,<STATE>,<FLAGS> |
118 |
|
|
119 |
State can have one of three values: |
State can have one of three values: |
120 |
0 : "Normal" window. |
0 : "Normal" window. |
121 |
1 : Minimised. |
1 : Minimized. |
122 |
2 : Maximised. |
2 : Maximized. |
123 |
|
|
124 |
|
The initial STATE for a window will always be preceeded by one CREATE and one |
125 |
|
POSITION. Optionally, a TITLE may also be sent before the first STATE. |
126 |
|
|
127 |
DEBUG1 |
DEBUG |
128 |
------ |
----- |
129 |
|
|
130 |
Debug output from the server component. |
Debug output from the server component. |
131 |
|
|
132 |
Syntax: |
Syntax: |
133 |
DEBUG1,<STRING> |
DEBUG,<STRING> |
134 |
|
|
135 |
Used for debugging. |
Used for debugging. |
136 |
|
|
168 |
Syntax: |
Syntax: |
169 |
SYNC,<FLAGS> |
SYNC,<FLAGS> |
170 |
|
|
171 |
For each window, the server will send CREATE1, POSITION1 and SETSTATE1 just as |
For each window, the server will send CREATE, POSITION and STATE, in that |
172 |
if the window was created. |
order, just as if the window was created. Note that a TITLE may also, |
173 |
|
optionally, be sent before the STATE. |
174 |
|
|
175 |
|
POSITION |
176 |
|
-------- |
177 |
|
|
178 |
|
Identical to the command sent from server to client. |
179 |
|
|
180 |
|
TITLE |
181 |
|
----- |
182 |
|
|
183 |
|
Identical to the command sent from server to client. |
184 |
|
|
185 |
|
ZCHANGE |
186 |
|
------- |
187 |
|
|
188 |
|
Identical to the command sent from server to client. |
189 |
|
|
190 |
|
STATE |
191 |
|
----- |
192 |
|
|
193 |
|
Identical to the command sent from server to client. |
194 |
|
|
195 |
|
FOCUS |
196 |
|
----- |
197 |
|
|
198 |
|
Sets which window has input focus. |
199 |
|
|
200 |
|
Syntax: |
201 |
|
FOCUS,<ID>,<FLAGS> |
202 |
|
|
203 |
|
Changes which window that will recieve the keyboard events. Note that this |
204 |
|
might cause the window to change z order. |