Skip to content

Commit 10e50e6

Browse files
markstosemersion
authored andcommitted
docs: use "window" instead of "view" throughout.
"view" is an internal term, while the commonly understood user-facing term is "window" Ref: #7323
1 parent c1031d8 commit 10e50e6

File tree

2 files changed

+65
-65
lines changed

2 files changed

+65
-65
lines changed

sway/sway-ipc.7.scd

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ has the following properties:
138138
: Whether the workspace is currently focused by the default seat (_seat0_)
139139
|- urgent
140140
: boolean
141-
: Whether a view on the workspace has the urgent flag set
141+
: Whether a window on the workspace has the urgent flag set
142142
|- rect
143143
: object
144144
: The bounds of the workspace. It consists of _x_, _y_, _width_, and _height_
@@ -374,7 +374,7 @@ node and will have the following properties:
374374
that can be used as an aid in submitting reproduction steps for bug reports
375375
|- fullscreen_mode
376376
: integer
377-
: (Only containers and views) The fullscreen mode of the node. 0 means none, 1 means
377+
: (Only containers and windows) The fullscreen mode of the node. 0 means none, 1 means
378378
full workspace, and 2 means global fullscreen
379379
|- floating
380380
: string
@@ -384,45 +384,45 @@ node and will have the following properties:
384384
: Whether the window is in the scratchpad. Can be either "none" or "fresh"
385385
|- app_id
386386
: string
387-
: (Only views) For an xdg-shell view, the name of the application, if set.
387+
: (Only windows) For an xdg-shell window, the name of the application, if set.
388388
Otherwise, _null_
389389
|- pid
390390
: integer
391-
: (Only views) The PID of the application that owns the view
391+
: (Only windows) The PID of the application that owns the window
392392
|- foreign_toplevel_identifier
393393
: string
394-
: (Only views) The ext-foreign-toplevel-list-v1 toplevel identifier of this node.
394+
: (Only windows) The ext-foreign-toplevel-list-v1 toplevel identifier of this node.
395395
|- visible
396396
: boolean
397-
: (Only views) Whether the node is visible
397+
: (Only windows) Whether the node is visible
398398
|- shell
399399
: string
400-
: (Only views) The shell of the view, such as _xdg\_shell_ or _xwayland_
400+
: (Only windows) The shell of the window, such as _xdg\_shell_ or _xwayland_
401401
|- inhibit_idle
402402
: boolean
403-
: (Only views) Whether the view is inhibiting the idle state
403+
: (Only windows) Whether the window is inhibiting the idle state
404404
|- idle_inhibitors
405405
: object
406-
: (Only views) An object containing the state of the _application_ and _user_ idle inhibitors.
406+
: (Only windows) An object containing the state of the _application_ and _user_ idle inhibitors.
407407
_application_ can be _enabled_ or _none_.
408408
_user_ can be _focus_, _fullscreen_, _open_, _visible_ or _none_.
409409
|- sandbox_engine
410410
: string
411-
: (Only views) The associated sandbox engine (or _null_)
411+
: (Only windows) The associated sandbox engine (or _null_)
412412
|- sandbox_app_id
413413
: string
414-
: (Only views) The app ID provided by the associated sandbox engine (or _null_)
414+
: (Only windows) The app ID provided by the associated sandbox engine (or _null_)
415415
|- sandbox_instance_id
416416
: string
417-
: (Only views) The instance ID provided by the associated sandbox engine (or
417+
: (Only windows) The instance ID provided by the associated sandbox engine (or
418418
_null_)
419419
|- window
420420
: integer
421-
: (Only xwayland views) The X11 window ID for the xwayland view
421+
: (Only xwayland windows) The X11 window ID for the xwayland window
422422
|- window_properties
423423
: object
424-
: (Only xwayland views) An object containing the _title_, _class_, _instance_,
425-
_window\_role_, _window\_type_, and _transient\_for_ for the view
424+
: (Only xwayland windows) An object containing the _title_, _class_, _instance_,
425+
_window\_role_, _window\_type_, and _transient\_for_ for the window
426426

427427

428428
*Example Reply:*
@@ -927,13 +927,13 @@ containing the _#RRGGBBAA_ representation of the color:
927927
that are not visible
928928
|- urgent_workspace_text
929929
: The color to use for the text of the workspace buttons for workspaces that
930-
contain an urgent view
930+
contain an urgent window
931931
|- urgent_workspace_bg
932932
: The color to use for the background of the workspace buttons for workspaces
933-
that contain an urgent view
933+
that contain an urgent window
934934
|- urgent_workspace_border
935935
: The color to use for the border of the workspace buttons for workspaces that
936-
contain an urgent view
936+
contain an urgent window
937937
|- binding_mode_text
938938
: The color to use for the text of the binding mode indicator
939939
|- binding_mode_bg
@@ -1480,7 +1480,7 @@ available:
14801480
: Sent whenever the binding mode changes
14811481
|- 0x80000003
14821482
: window
1483-
: Sent whenever an event involving a view occurs such as being reparented,
1483+
: Sent whenever an event involving a window occurs such as being reparented,
14841484
focused, or closed
14851485
|- 0x80000004
14861486
: barconfig_update
@@ -1536,8 +1536,8 @@ The following change types are currently available:
15361536
|- rename
15371537
: The workspace was renamed
15381538
|- urgent
1539-
: A view on the workspace has had their urgency hint set or all urgency hints
1540-
for views on the workspace have been cleared
1539+
: A window on the workspace has had their urgency hint set or all urgency hints
1540+
for windows on the workspace have been cleared
15411541
|- reload
15421542
: The configuration file has been reloaded
15431543

@@ -1635,7 +1635,7 @@ with the following properties:
16351635

16361636
## 0x80000003. WINDOW
16371637

1638-
Sent whenever a change involving a view occurs. The event consists of a single
1638+
Sent whenever a change involving a window occurs. The event consists of a single
16391639
object with the following properties:
16401640

16411641
[- *PROPERTY*
@@ -1646,30 +1646,30 @@ object with the following properties:
16461646
:[ The type of change that occurred. See below for more information
16471647
|- container
16481648
: object
1649-
: An object representing the view effected
1649+
: An object representing the window effected
16501650

16511651

16521652
The following change types are currently available:
16531653
[- *TYPE*
16541654
:- *DESCRIPTION*
16551655
|- new
1656-
:[ The view was created
1656+
:[ The window was created
16571657
|- close
1658-
: The view was closed
1658+
: The window was closed
16591659
|- focus
1660-
: The view was focused
1660+
: The window was focused
16611661
|- title
1662-
: The view's title has changed
1662+
: The window's title has changed
16631663
|- fullscreen_mode
1664-
: The view's fullscreen mode has changed
1664+
: The window's fullscreen mode has changed
16651665
|- move
1666-
: The view has been reparented in the tree
1666+
: The window has been reparented in the tree
16671667
|- floating
1668-
: The view has become floating or is no longer floating
1668+
: The window has become floating or is no longer floating
16691669
|- urgent
1670-
: The view's urgency hint has changed status
1670+
: The window's urgency hint has changed status
16711671
|- mark
1672-
: A mark has been added or removed from the view
1672+
: A mark has been added or removed from the window
16731673

16741674

16751675
*Example Event:*

sway/sway.5.scd

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ They are expected to be used with *bindsym* or at runtime through *swaymsg*(1).
117117
Exit sway and end your Wayland session.
118118

119119
*floating* enable|disable|toggle
120-
Make focused view floating, non-floating, or the opposite of what it is now.
120+
Make focused window floating, non-floating, or the opposite of what it is now.
121121

122122
<criteria> *focus*
123123
Moves focus to the container that matches the specified criteria.
@@ -152,9 +152,9 @@ They are expected to be used with *bindsym* or at runtime through *swaymsg*(1).
152152
Moves focus between the floating and tiled layers.
153153

154154
*fullscreen* [enable|disable|toggle] [global]
155-
Makes focused view fullscreen, non-fullscreen, or the opposite of what it
155+
Makes focused window fullscreen, non-fullscreen, or the opposite of what it
156156
is now. If no argument is given, it does the same as _toggle_. If _global_
157-
is specified, the view will be fullscreen across all outputs.
157+
is specified, the window will be fullscreen across all outputs.
158158

159159
*gaps* inner|outer|horizontal|vertical|top|right|bottom|left all|current
160160
set|plus|minus|toggle <amount>
@@ -164,16 +164,16 @@ set|plus|minus|toggle <amount>
164164
_vertical_.
165165

166166
*inhibit_idle* focus|fullscreen|open|none|visible
167-
Set/unset an idle inhibitor for the view. _focus_ will inhibit idle when
168-
the view is focused by any seat. _fullscreen_ will inhibit idle when the
167+
Set/unset an idle inhibitor for the window. _focus_ will inhibit idle when
168+
the window is focused by any seat. _fullscreen_ will inhibit idle when the
169169
view is fullscreen (or a descendant of a fullscreen container) and is
170-
visible. _open_ will inhibit idle until the view is closed (or the
171-
inhibitor is unset/changed). _visible_ will inhibit idle when the view is
170+
visible. _open_ will inhibit idle until the window is closed (or the
171+
inhibitor is unset/changed). _visible_ will inhibit idle when the window is
172172
visible on any output. _none_ will remove any existing idle inhibitor for
173-
the view.
173+
the window.
174174

175175
This can also be used with criteria to set an idle inhibitor for any
176-
existing view or with _for_window_ to set idle inhibitors for future views.
176+
existing window or with _for_window_ to set idle inhibitors for future windows.
177177

178178
*layout* default|splith|splitv|stacking|tabbed
179179
Sets the layout mode of the focused container.
@@ -331,12 +331,12 @@ set|plus|minus|toggle <amount>
331331

332332
*shortcuts_inhibitor* enable|disable
333333
Enables or disables the ability of clients to inhibit keyboard
334-
shortcuts for a view. This is primarily useful for virtualization and
335-
remote desktop software. It affects either the currently focused view
336-
or a set of views selected by criteria. Subcommand _disable_
337-
additionally deactivates any active inhibitors for the given view(s).
334+
shortcuts for a window. This is primarily useful for virtualization and
335+
remote desktop software. It affects either the currently focused window
336+
or a set of windows selected by criteria. Subcommand _disable_
337+
additionally deactivates any active inhibitors for the given window(s).
338338
Criteria are particularly useful with the *for_window* command to
339-
configure a class of views differently from the per-seat defaults
339+
configure a class of windows differently from the per-seat defaults
340340
established by the *seat* subcommand of the same name. See
341341
*sway-input*(5) for more ways to affect inhibitors.
342342

@@ -364,7 +364,7 @@ set|plus|minus|toggle <amount>
364364
Swaps the position, geometry, and fullscreen status of two containers. The
365365
first container can be selected either by criteria or focus. The second
366366
container can be selected by _id_, _con_id_, or _mark_. _id_ can only be
367-
used with xwayland views. If the first container has focus, it will retain
367+
used with xwayland windows. If the first container has focus, it will retain
368368
focus unless it is moved to a different workspace or the second container
369369
becomes fullscreen on the same workspace as the first container. In either
370370
of those cases, the second container will gain focus.
@@ -409,14 +409,14 @@ The following commands may be used either in the configuration file or at
409409
runtime.
410410

411411
*assign* <criteria> [] [workspace] [number] <workspace>
412-
Assigns views matching _criteria_ (see *CRITERIA* for details) to
412+
Assigns windows matching _criteria_ (see *CRITERIA* for details) to
413413
_workspace_. The → (U+2192) is optional and cosmetic. This command is
414414
equivalent to:
415415

416416
for_window <criteria> move container to workspace <workspace>
417417

418418
*assign* <criteria> [] output left|right|up|down|<name>
419-
Assigns views matching _criteria_ (see *CRITERIA* for details) to the
419+
Assigns windows matching _criteria_ (see *CRITERIA* for details) to the
420420
specified output. The → (U+2192) is optional and cosmetic. This command is
421421
equivalent to:
422422

@@ -599,10 +599,10 @@ runtime.
599599
The window that has focus.
600600

601601
*client.focused_inactive*
602-
The most recently focused view within a container which is not focused.
602+
The most recently focused window within a container which is not focused.
603603

604604
*client.focused_tab_title*
605-
A view that has focused descendant container.
605+
A window that has focused descendant container.
606606
Tab or stack container title that is the parent of the focused container
607607
but is not directly focused. Defaults to focused_inactive if not
608608
specified and does not use the indicator and child_border colors.
@@ -611,10 +611,10 @@ runtime.
611611
Ignored (present for i3 compatibility).
612612

613613
*client.unfocused*
614-
A view that does not have focus.
614+
A window that does not have focus.
615615

616616
*client.urgent*
617-
A view with an urgency hint. *Note*: Native Wayland windows do not
617+
A window with an urgency hint. *Note*: Native Wayland windows do not
618618
support urgency. Urgency only works for Xwayland windows.
619619

620620
The meaning of each color is:
@@ -629,12 +629,12 @@ runtime.
629629
The text color of the title bar.
630630

631631
_indicator_
632-
The color used to indicate where a new view will open. In a tiled
633-
container, this would paint the right border of the current view if a
634-
new view would be opened to the right.
632+
The color used to indicate where a new window will open. In a tiled
633+
container, this would paint the right border of the current window if a
634+
new window would be opened to the right.
635635

636636
_child_border_
637-
The border around the view itself.
637+
The border around the window itself.
638638

639639
The default colors are:
640640

@@ -772,7 +772,7 @@ The default colors are:
772772

773773
*gaps* inner|outer|horizontal|vertical|top|right|bottom|left <amount>
774774
Sets default _amount_ pixels of _inner_ or _outer_ gap, where the inner
775-
affects spacing around each view and outer affects the spacing around each
775+
affects spacing around each window and outer affects the spacing around each
776776
workspace. Outer gaps are in addition to inner gaps. To reduce or remove
777777
outer gaps, outer gaps can be set to a negative value. _outer_ gaps can
778778
also be specified per side with _top_, _right_, _bottom_, and _left_ or
@@ -844,9 +844,9 @@ The default colors are:
844844
A list of output names may be obtained via *swaymsg -t get_outputs*.
845845

846846
*popup_during_fullscreen* smart|ignore|leave_fullscreen
847-
Determines what to do when a fullscreen view opens a dialog.
847+
Determines what to do when a fullscreen window opens a dialog.
848848
If _smart_ (the default), the dialog will be displayed. If _ignore_, the
849-
dialog will not be rendered. If _leave_fullscreen_, the view will exit
849+
dialog will not be rendered. If _leave_fullscreen_, the window will exit
850850
fullscreen mode and the dialog will be rendered.
851851

852852
*primary_selection* enabled|disabled
@@ -976,14 +976,14 @@ A criteria is a string in the form of, for example:
976976
```
977977

978978
The string contains one or more (space separated) attribute/value pairs. They
979-
are used by some commands to choose which views to execute actions on. All
979+
are used by some commands to choose which windows to execute actions on. All
980980
attributes must match for the criteria to match. Criteria is retained across
981981
commands separated by a *,*, but will be reset (and allow for new criteria, if
982982
desired) for commands separated by a *;*.
983983

984984
Criteria may be used with either the *for_window* or *assign* commands to
985-
specify operations to perform on new views. A criteria may also be used to
986-
perform specific commands (ones that normally act upon one window) on all views
985+
specify operations to perform on new windows. A criteria may also be used to
986+
perform specific commands (ones that normally act upon one window) on all windows
987987
that match that criteria. For example:
988988

989989
Focus on a window with the mark "IRC":
@@ -1071,8 +1071,8 @@ The following attributes may be matched with:
10711071
applications and requires XWayland.
10721072

10731073
*workspace*
1074-
Compare against the workspace name for this view. Can be a regular
1075-
expression. If the value is \_\_focused\_\_, then all the views on the
1074+
Compare against the workspace name for this window. Can be a regular
1075+
expression. If the value is \_\_focused\_\_, then all the windows on the
10761076
currently focused workspace matches.
10771077

10781078
*sandbox_engine*

0 commit comments

Comments
 (0)