![]() |
![]() |
![]() |
plank Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties |
#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;
GObject +----GInitiallyUnowned +----GtkWidget +----GtkContainer +----GtkBin +----GtkWindow +----PlankWidgetsCompositedWindow +----PlankWidgetsDockWindow
"HoveredItem" PlankItemsDockItem* : Read / Write "controller" PlankDockController* : Write / Construct Only
#define PLANK_WIDGETS_TYPE_DOCK_WINDOW (plank_widgets_dock_window_get_type ())
The type for PlankWidgetsDockWindow.
void plank_widgets_dock_window_set_hovered (PlankWidgetsDockWindow *self
,PlankItemsDockItem *item
);
Sets the currently hovered item for this dock.
|
the PlankWidgetsDockWindow instance |
|
. the hovered item (if any) for this dock. [in][allow-none] |
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.
|
the PlankWidgetsDockWindow instance |
|
. the cursor x position. [in] |
|
. the cursor x position. [in] |
Returns : |
if a dock item is hovered |
void plank_widgets_dock_window_position_hover
(PlankWidgetsDockWindow *self
);
Repositions the hover window for the hovered item.
|
the PlankWidgetsDockWindow instance |
void plank_widgets_dock_window_drag_item_changed
(PlankWidgetsDockWindow *self
);
Called when a dragged item changes.
|
the PlankWidgetsDockWindow instance |
void plank_widgets_dock_window_update_size_and_position
(PlankWidgetsDockWindow *self
);
Sets the size of the dock window and repositions it if needed.
|
the PlankWidgetsDockWindow instance |
void plank_widgets_dock_window_update_icon_regions
(PlankWidgetsDockWindow *self
);
Updates the icon regions for all items on the dock.
|
the PlankWidgetsDockWindow instance |
gboolean plank_widgets_dock_window_menu_is_visible
(PlankWidgetsDockWindow *self
);
If the popup menu is currently visible.
|
the PlankWidgetsDockWindow instance |
void plank_widgets_dock_window_show_menu (PlankWidgetsDockWindow *self
,guint button
,gboolean show_plank_menu
);
Shows the popup menu.
|
the PlankWidgetsDockWindow instance |
|
. the button used to trigger the popup. [in] |
|
. if the 'global' menu should be shown. [in] |
void plank_widgets_dock_window_on_menu_hide
(PlankWidgetsDockWindow *self
);
Called when the popup menu hides.
|
the PlankWidgetsDockWindow instance |
void plank_widgets_dock_window_on_menu_show
(PlankWidgetsDockWindow *self
);
Called when the popup menu shows.
|
the PlankWidgetsDockWindow instance |
void plank_widgets_dock_window_position_menu (PlankWidgetsDockWindow *self
,GtkMenu *menu
,gint *x
,gint *y
,gboolean *push_in
);
Positions the popup menu.
|
the PlankWidgetsDockWindow instance |
|
. the popup menu to show. [in] |
|
. the x location to show the menu. [out] |
|
. the y location to show the menu. [out] |
|
. if the menu should push into the screen. [out] |
PlankWidgetsDockWindow * plank_widgets_dock_window_new (PlankDockController *controller
);
Creates a new dock window.
|
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).
|
the PlankWidgetsDockWindow instance to query |
Returns : |
the value of the "HoveredItem" property |
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).
|
the PlankWidgetsDockWindow instance to modify |
|
the new value of the "HoveredItem" property |
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 |
the parent class structure |
"HoveredItem"
property"HoveredItem" PlankItemsDockItem* : Read / Write
The currently hovered item (if any).
"controller"
property"controller" PlankDockController* : Write / Construct Only
The controller for this dock.