Class
PhocView
Description [src]
class Phoc.View : GObject.Object {
parent_instance: GObject,
desktop: PhocDesktop*,
link: wl_list,
parent_link: wl_list,
box: wlr_box,
saved: wlr_box,
pending_centering: _Bool,
parent: PhocView*,
stack: wl_list,
wlr_surface: wlr_surface*
}A PhocView represents a toplevel like an xdg-toplevel or a xwayland window.
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().
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.
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.
phoc_view_flush_activation_token
Notifies that the compositor handled processing the activation token and clears it.
phoc_view_get_fullscreen_output
Gets the output a view is fullscreen on. Returns NULL if
the view isn’t currently fullscreen.
phoc_view_get_maximized_box
Gets the “visible bounds” that a view will use on a given output when maximized.
phoc_view_get_output
If a view spans multiple output it returns the output that the center of the view is on.
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.
phoc_view_set_decoration
Sets whether the window is decorated. If TRUE also specifies the decoration.
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.
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.
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: GObjectClassThe 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 )- No description available.
resize: void (* resize) ( PhocView* self, uint32_t width, uint32_t height )- No description available.
move_resize: void (* move_resize) ( PhocView* self, double x, double y, uint32_t width, uint32_t height )- No description available.
want_scaling: _Bool (* want_scaling) ( PhocView* self )- No description available.
want_auto_maximize: _Bool (* want_auto_maximize) ( PhocView* self )- No description available.
set_active: void (* set_active) ( PhocView* self, _Bool active )- No description available.
set_fullscreen: void (* set_fullscreen) ( PhocView* self, _Bool fullscreen )- No description available.
set_maximized: void (* set_maximized) ( PhocView* self, _Bool maximized )- No description available.
set_tiled: void (* set_tiled) ( PhocView* self, _Bool tiled )- No description available.
close: void (* close) ( PhocView* self )- No description available.
for_each_surface: void (* for_each_surface) ( PhocView* self, wlr_surface_iterator_func_t iterator, void* user_data )- No description available.
get_geometry: void (* get_geometry) ( PhocView* self, wlr_box* box )- No description available.
get_wlr_surface_at: wlr_surface* (* get_wlr_surface_at) ( PhocView* self, double sx, double sy, double* sub_x, double* sub_y )- No description available.
get_pid: pid_t (* get_pid) ( PhocView* self )- No description available.