Skip to content

Commit 660eb25

Browse files
author
pinnacle-comp
committed
1 parent 5fd29d4 commit 660eb25

3 files changed

Lines changed: 83 additions & 0 deletions

File tree

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
outline: [2, 3]
3+
---
4+
5+
# Class `pinnacle.tag.MoveToOutputError`
6+
7+
8+
9+
10+
## Fields
11+
12+
### output_does_not_exist <Badge type="danger" text="nullable" />
13+
14+
`output_does_not_exist?`: <code>boolean</code>
15+
16+
`true` if the output does not exist.
17+
18+
### same_window_on_two_outputs <Badge type="danger" text="nullable" />
19+
20+
`same_window_on_two_outputs?`: <code><a href="/lua-reference/main/classes/pinnacle.window.WindowHandle">pinnacle.window.WindowHandle</a>[]</code>
21+
22+
This operation would cause the provided windows to be on multiple outputs.
23+
24+

main/classes/pinnacle.tag.TagHandle.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,32 @@ Tag.get("2"):toggle_active() -- Displays nothing
112112

113113

114114

115+
### <Badge type="method" text="method" /> move_to_output
116+
117+
<div class="language-lua"><pre><code>function pinnacle.tag.TagHandle:move_to_output(output: <a href="/lua-reference/main/classes/pinnacle.output.OutputHandle">pinnacle.output.OutputHandle</a>)
118+
-> ok: boolean, err: <a href="/lua-reference/main/classes/pinnacle.tag.MoveToOutputError">pinnacle.tag.MoveToOutputError</a> | nil</code></pre></div>
119+
120+
Moves this tag to the specified output.
121+
122+
123+
124+
#### Parameters
125+
126+
`output` - The output to move this tag to.<br>
127+
&emsp; ┃ <code><a href="/lua-reference/main/classes/pinnacle.output.OutputHandle">pinnacle.output.OutputHandle</a></code><br>
128+
129+
130+
131+
#### Returns
132+
133+
1. `ok`: <code>boolean</code> - `true` on success.
134+
2. `err`: <code><a href="/lua-reference/main/classes/pinnacle.tag.MoveToOutputError">pinnacle.tag.MoveToOutputError</a> | nil</code> - Error on failure.
135+
136+
137+
138+
#### See also
139+
140+
- <code><a href="/lua-reference/main/classes/pinnacle.tag#move_to_output">pinnacle.tag.move_to_output</a></code>: - for further information
115141
### <Badge type="method" text="method" /> active
116142

117143
<div class="language-lua"><pre><code>function pinnacle.tag.TagHandle:active()

main/classes/pinnacle.tag.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,39 @@ Tag.remove(tags) -- "HDMI-1" no longer has those tags
150150

151151

152152

153+
### <Badge type="function" text="function" /> move_to_output
154+
155+
<div class="language-lua"><pre><code>function pinnacle.tag.move_to_output(output: <a href="/lua-reference/main/classes/pinnacle.output.OutputHandle">pinnacle.output.OutputHandle</a>, tags: <a href="/lua-reference/main/classes/pinnacle.tag.TagHandle">pinnacle.tag.TagHandle</a>[])
156+
-> ok: boolean, err: <a href="/lua-reference/main/classes/pinnacle.tag.MoveToOutputError">pinnacle.tag.MoveToOutputError</a> | nil</code></pre></div>
157+
158+
Moves existing tags to the specified output.
159+
160+
#### Example
161+
```lua
162+
local tag_to_move = Tag.get("1")
163+
Tag.move_to_output(Output.get_by_name("HDMI-1"), { tag_to_move })
164+
```
165+
166+
167+
168+
#### Parameters
169+
170+
`output` - The output to move tags to.<br>
171+
&emsp; ┃ <code><a href="/lua-reference/main/classes/pinnacle.output.OutputHandle">pinnacle.output.OutputHandle</a></code><br>
172+
173+
`tags` - The tags to move.<br>
174+
&emsp; ┃ <code><a href="/lua-reference/main/classes/pinnacle.tag.TagHandle">pinnacle.tag.TagHandle</a>[]</code><br>
175+
176+
177+
178+
#### Returns
179+
180+
1. `ok`: <code>boolean</code> - `true` on success.
181+
2. `err`: <code><a href="/lua-reference/main/classes/pinnacle.tag.MoveToOutputError">pinnacle.tag.MoveToOutputError</a> | nil</code> - Error on failure.
182+
183+
184+
185+
153186
### <Badge type="function" text="function" /> connect_signal
154187

155188
<div class="language-lua"><pre><code>function pinnacle.tag.connect_signal(signals: <a href="/lua-reference/main/classes/pinnacle.tag.TagSignal">pinnacle.tag.TagSignal</a>)

0 commit comments

Comments
 (0)