Class
PhocView
since: 0
Description [src]
class Phoc.View : GObject.Object
{
desktop: PhocDesktop*,
box: wlr_box,
saved: wlr_box,
pending_centering: _Bool,
parent: PhocView*,
stack: wl_list,
parent_link: wl_list,
wlr_surface: wlr_surface*
}
A PhocView
represents a toplevel like an xdg-toplevel or a xwayland window.
Available since: 0
Instance methods
phoc_view_activate
Performs the necessary steps to make the view itself appear activated
and send out the corresponding view related protocol events.
Note that this is not enough to actually focus the view for the user
See phoc_seat_set_focus_view()
.
since: 0
phoc_view_add_bling
By adding a PhocBling
to a view you ensure that it gets rendered
just before the view if both the view and the bling are mapped.
since: 0
phoc_view_arrange
Arrange a view based on it’s current state (floating, tiled or
maximized). If the view is neither tiled nor maximized and
center
is FALSE
this operation is a noop.
since: 0
phoc_view_damage_whole
Add the damage of all surfaces belonging to a PhocView
to the
damaged screen area that needs repaint. This damages the whole
view
(possibly including server side window decorations) ignoring
any buffer damage.
since: 0
phoc_view_flush_activation_token
Notifies that the compositor handled processing the activation token and clears it.
since: 0
phoc_view_get_fullscreen_output
Gets the output a view is fullscreen on. Returns NULL
if
the view isn’t currently fullscreen.
since: 0
phoc_view_get_maximized_box
Gets the “visible bounds” that a view will use on a given output when maximized.
since: 0
phoc_view_get_output
If a view spans multiple output it returns the output that the center of the view is on.
since: 0
phoc_view_get_tiled_box
Gets the “visible bounds” a view will use on a given output when tiled.
since: 0
phoc_view_restore
Put a view back into floating state while restoring it’s previous size and position.
since: 0
phoc_view_set_activation_token
Sets the activation token that will be used when activate the view once mapped. It will be cleared once the view got activated.
since: 0
phoc_view_set_always_on_top
Specifies whether the view should be rendered on top of other views.
since: 0
phoc_view_set_decorated
Sets whether the window is decorated. If TRUE
also specifies the decoration.
since: 0
phoc_view_set_fullscreen
If fullscreen
is true
. fullscreens a view on the given output or
(if output
is NULL
) on the view’s current output. Unfullscreens
the view
if fullscreens
is false
.
since: 0
phoc_view_set_scale_to_fit
Turn auto scaling if oversized for this surface on (TRUE
) or off (FALSE
)
since: 0
Properties
Phoc.View:activation-token
If not NULL
this token will be used to activate the view once mapped.
since: 0
Signals
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
unstable since: 2.0
Class structure
struct PhocViewClass {
GObjectClass parent_class;
void (* move) (
PhocView* self,
double x,
double y
);
void (* resize) (
PhocView* self,
uint32_t width,
uint32_t height
);
void (* move_resize) (
PhocView* self,
double x,
double y,
uint32_t width,
uint32_t height
);
_Bool (* want_scaling) (
PhocView* self
);
_Bool (* want_auto_maximize) (
PhocView* self
);
void (* set_active) (
PhocView* self,
_Bool active
);
void (* set_fullscreen) (
PhocView* self,
_Bool fullscreen
);
void (* set_maximized) (
PhocView* self,
_Bool maximized
);
void (* set_tiled) (
PhocView* self,
_Bool tiled
);
void (* close) (
PhocView* self
);
void (* for_each_surface) (
PhocView* self,
wlr_surface_iterator_func_t iterator,
void* user_data
);
void (* get_geometry) (
PhocView* self,
wlr_box* box
);
wlr_surface* (* get_wlr_surface_at) (
PhocView* self,
double sx,
double sy,
double* sub_x,
double* sub_y
);
pid_t (* get_pid) (
PhocView* self
);
}
Class members
parent_class: GObjectClass
The object class structure needs to be the first element in the widget class structure in order for the class mechanism to work correctly. This allows a PhocViewClass pointer to be cast to a GObjectClass pointer.
move: void (* move) ( PhocView* self, double x, double y )
This is called by
PhocView
to move a view to a new position. The implementation is optional.resize: void (* resize) ( PhocView* self, uint32_t width, uint32_t height )
This is called by
PhocView
to move resize a view.move_resize: void (* move_resize) ( PhocView* self, double x, double y, uint32_t width, uint32_t height )
This is called by
PhocView
to move and resize a view a the same time.want_scaling: _Bool (* want_scaling) ( PhocView* self )
- No description available.
want_auto_maximize: _Bool (* want_auto_maximize) ( PhocView* self )
This is called by
PhocView
to determine if a view should be automatically maximized.set_active: void (* set_active) ( PhocView* self, _Bool active )
This is called by
PhocView
to make a view appear active.set_fullscreen: void (* set_fullscreen) ( PhocView* self, _Bool fullscreen )
This is called by
PhocView
to fullscreen a view.set_maximized: void (* set_maximized) ( PhocView* self, _Bool maximized )
This is called by
PhocView
to maximize a view.set_tiled: void (* set_tiled) ( PhocView* self, _Bool tiled )
This is called by
PhocView
to tile a view. The implementation is optional.close: void (* close) ( PhocView* self )
This is called by
PhocView
to close a view.for_each_surface: void (* for_each_surface) ( PhocView* self, wlr_surface_iterator_func_t iterator, void* user_data )
This is used by
PhocView
to iterate over a surface and it’s children. The implementation is optional.get_geometry: void (* get_geometry) ( PhocView* self, wlr_box* box )
This is called by
PhocView
to get a views geometry. The implementation is optional.get_wlr_surface_at: wlr_surface* (* get_wlr_surface_at) ( PhocView* self, double sx, double sy, double* sub_x, double* sub_y )
Get the wlr_surface at the give coordinates. The implementation is optional.
get_pid: pid_t (* get_pid) ( PhocView* self )
- No description available.
Virtual methods
Phoc.ViewClass.for_each_surface
This is used by PhocView
to iterate over a surface and it’s children.
The implementation is optional.
since: 0
Phoc.ViewClass.get_geometry
This is called by PhocView
to get a views geometry.
The implementation is optional.
since: 0
Phoc.ViewClass.get_wlr_surface_at
Get the wlr_surface at the give coordinates. The implementation is optional.
since: 0
Phoc.ViewClass.move
This is called by PhocView
to move a view to a new position.
The implementation is optional.
since: 0
Phoc.ViewClass.move_resize
This is called by PhocView
to move and resize a view a the same time.
since: 0
Phoc.ViewClass.set_tiled
This is called by PhocView
to tile a view.
The implementation is optional.
since: 0
Phoc.ViewClass.want_auto_maximize
This is called by PhocView
to determine if a view should
be automatically maximized.
since: 0