PlankWidgetsDockWindow

PlankWidgetsDockWindow — The main window for all docks.

Synopsis

#define             PLANK_WIDGETS_TYPE_DOCK_WINDOW
void                plank_widgets_dock_window_set_hovered
                                                        (PlankWidgetsDockWindow *self,
                                                         PlankItemsDockItem *item);
gboolean            plank_widgets_dock_window_update_hovered
                                                        (PlankWidgetsDockWindow *self,
                                                         gint x,
                                                         gint y);
void                plank_widgets_dock_window_position_hover
                                                        (PlankWidgetsDockWindow *self);
void                plank_widgets_dock_window_drag_item_changed
                                                        (PlankWidgetsDockWindow *self);
void                plank_widgets_dock_window_update_size_and_position
                                                        (PlankWidgetsDockWindow *self);
void                plank_widgets_dock_window_update_icon_regions
                                                        (PlankWidgetsDockWindow *self);
gboolean            plank_widgets_dock_window_menu_is_visible
                                                        (PlankWidgetsDockWindow *self);
void                plank_widgets_dock_window_show_menu (PlankWidgetsDockWindow *self,
                                                         guint button,
                                                         gboolean show_plank_menu);
void                plank_widgets_dock_window_on_menu_hide
                                                        (PlankWidgetsDockWindow *self);
void                plank_widgets_dock_window_on_menu_show
                                                        (PlankWidgetsDockWindow *self);
void                plank_widgets_dock_window_position_menu
                                                        (PlankWidgetsDockWindow *self,
                                                         GtkMenu *menu,
                                                         gint *x,
                                                         gint *y,
                                                         gboolean *push_in);
PlankWidgetsDockWindow * plank_widgets_dock_window_new  (PlankDockController *controller);
PlankItemsDockItem * plank_widgets_dock_window_get_HoveredItem
                                                        (PlankWidgetsDockWindow *self);
void                plank_widgets_dock_window_set_HoveredItem
                                                        (PlankWidgetsDockWindow *self,
                                                         PlankItemsDockItem *value);
struct              PlankWidgetsDockWindow;
struct              PlankWidgetsDockWindowClass;

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkWidget
               +----GtkContainer
                     +----GtkBin
                           +----GtkWindow
                                 +----PlankWidgetsCompositedWindow
                                       +----PlankWidgetsDockWindow

Implemented Interfaces

PlankWidgetsDockWindow implements AtkImplementorIface and GtkBuildable.

Properties

  "HoveredItem"              PlankItemsDockItem*   : Read / Write
  "controller"               PlankDockController*  : Write / Construct Only

Description

Details

PLANK_WIDGETS_TYPE_DOCK_WINDOW

#define PLANK_WIDGETS_TYPE_DOCK_WINDOW (plank_widgets_dock_window_get_type ())

The type for PlankWidgetsDockWindow.


plank_widgets_dock_window_set_hovered ()

void                plank_widgets_dock_window_set_hovered
                                                        (PlankWidgetsDockWindow *self,
                                                         PlankItemsDockItem *item);

Sets the currently hovered item for this dock.

self :

the PlankWidgetsDockWindow instance

item :

 . the hovered item (if any) for this dock. [in][allow-none]

plank_widgets_dock_window_update_hovered ()

gboolean            plank_widgets_dock_window_update_hovered
                                                        (PlankWidgetsDockWindow *self,
                                                         gint x,
                                                         gint y);

Determines if an item is hovered by the cursor at the x/y position.

self :

the PlankWidgetsDockWindow instance

x :

 . the cursor x position. [in]

y :

 . the cursor x position. [in]

Returns :

if a dock item is hovered

plank_widgets_dock_window_position_hover ()

void                plank_widgets_dock_window_position_hover
                                                        (PlankWidgetsDockWindow *self);

Repositions the hover window for the hovered item.

self :

the PlankWidgetsDockWindow instance

plank_widgets_dock_window_drag_item_changed ()

void                plank_widgets_dock_window_drag_item_changed
                                                        (PlankWidgetsDockWindow *self);

Called when a dragged item changes.

self :

the PlankWidgetsDockWindow instance

plank_widgets_dock_window_update_size_and_position ()

void                plank_widgets_dock_window_update_size_and_position
                                                        (PlankWidgetsDockWindow *self);

Sets the size of the dock window and repositions it if needed.

self :

the PlankWidgetsDockWindow instance

plank_widgets_dock_window_update_icon_regions ()

void                plank_widgets_dock_window_update_icon_regions
                                                        (PlankWidgetsDockWindow *self);

Updates the icon regions for all items on the dock.

self :

the PlankWidgetsDockWindow instance

plank_widgets_dock_window_menu_is_visible ()

gboolean            plank_widgets_dock_window_menu_is_visible
                                                        (PlankWidgetsDockWindow *self);

If the popup menu is currently visible.

self :

the PlankWidgetsDockWindow instance

plank_widgets_dock_window_show_menu ()

void                plank_widgets_dock_window_show_menu (PlankWidgetsDockWindow *self,
                                                         guint button,
                                                         gboolean show_plank_menu);

Shows the popup menu.

self :

the PlankWidgetsDockWindow instance

button :

 . the button used to trigger the popup. [in]

show_plank_menu :

 . if the 'global' menu should be shown. [in]

plank_widgets_dock_window_on_menu_hide ()

void                plank_widgets_dock_window_on_menu_hide
                                                        (PlankWidgetsDockWindow *self);

Called when the popup menu hides.

self :

the PlankWidgetsDockWindow instance

plank_widgets_dock_window_on_menu_show ()

void                plank_widgets_dock_window_on_menu_show
                                                        (PlankWidgetsDockWindow *self);

Called when the popup menu shows.

self :

the PlankWidgetsDockWindow instance

plank_widgets_dock_window_position_menu ()

void                plank_widgets_dock_window_position_menu
                                                        (PlankWidgetsDockWindow *self,
                                                         GtkMenu *menu,
                                                         gint *x,
                                                         gint *y,
                                                         gboolean *push_in);

Positions the popup menu.

self :

the PlankWidgetsDockWindow instance

menu :

 . the popup menu to show. [in]

x :

 . the x location to show the menu. [out]

y :

 . the y location to show the menu. [out]

push_in :

 . if the menu should push into the screen. [out]

plank_widgets_dock_window_new ()

PlankWidgetsDockWindow * plank_widgets_dock_window_new  (PlankDockController *controller);

Creates a new dock window.

controller :

 

plank_widgets_dock_window_get_HoveredItem ()

PlankItemsDockItem * plank_widgets_dock_window_get_HoveredItem
                                                        (PlankWidgetsDockWindow *self);

Get and return the current value of the "HoveredItem" property.

The currently hovered item (if any).

self :

the PlankWidgetsDockWindow instance to query

Returns :

the value of the "HoveredItem" property

plank_widgets_dock_window_set_HoveredItem ()

void                plank_widgets_dock_window_set_HoveredItem
                                                        (PlankWidgetsDockWindow *self,
                                                         PlankItemsDockItem *value);

Set the value of the "HoveredItem" property to value.

The currently hovered item (if any).

self :

the PlankWidgetsDockWindow instance to modify

value :

the new value of the "HoveredItem" property

struct PlankWidgetsDockWindow

struct PlankWidgetsDockWindow;

The main window for all docks.


struct PlankWidgetsDockWindowClass

struct PlankWidgetsDockWindowClass {
	PlankWidgetsCompositedWindowClass parent_class;
};

The class structure for PLANK_WIDGETS_TYPE_DOCK_WINDOW. All the fields in this structure are private and should never be accessed directly.

PlankWidgetsCompositedWindowClass parent_class;

the parent class structure

Property Details

The "HoveredItem" property

  "HoveredItem"              PlankItemsDockItem*   : Read / Write

The currently hovered item (if any).


The "controller" property

  "controller"               PlankDockController*  : Write / Construct Only

The controller for this dock.