Basic class for each window.
Each of the windows in Shade are derived internally from this class.
These methods and properties are inherited for all windows.
The methods and properties contained here were made for use with the main Shade application and plug-ins, and are not guaranteed to work in scripts, so use appropriate caution.
xshade |
↑ |
window |
bring_to_front | Move the window to the front |
hide | Hides the window |
show | Displays the window |
show_hide | Hides the window if it is displayed, and displays it if it is hidden |
update | Updates the view |
canvas_size | The canvas size |
client_size | The size of the client area |
frame_position | The position of the window on the display |
frame_rectangle | The window rectangle on the display |
is_shown | Whether the window is displayed or not |
title | The window title |
Used after getting the window class with a method such as xshade.aggregate_view().
bring_to_front
Moves the window to the front.
xshade.aggregate_view().bring_to_front()
hide
Hides the window.
xshade.aggregate_view().hide()
show
Displays the window.
xshade.aggregate_view().show()
show_hide
Hides the window if it is displayed, and displays it if it is hidden.
xshade.aggregate_view().show_hide()
update
Updates the view.
xshade.aggregate_view().update()
canvas_size
The canvas size.
Type :
size
print xshade.aggregate_view().canvas_size
client_size
The size of the client area.
Type :
size
print xshade.aggregate_view().client_size
frame_position
The position of the window on the display.
Type :
(int, int) : (left, top) int tuple/list
In the case of an Aggregate Window item integrated therein, these are the coordinates relative to the Aggregate Window.
print xshade.aggregate_view().frame_position
frame_rectangle
The window rectangle on the display.
Type :
rectangle
In the case of an Aggregate Window item integrated therein, these are the coordinates relative to the Aggregate Window.
print xshade.aggregate_view().frame_rectangle
is_shown
Whether the window is displayed or not.
Type :
bool
print xshade.aggregate_view().is_shown
title
The window title.
Type :
string
May also set the window title, but only temporarily.
print xshade.aggregate_window().title