PlankHideManager

PlankHideManager — Class to handle checking if a dock should hide or not.

Synopsis

#define             PLANK_TYPE_HIDE_MANAGER
void                plank_hide_manager_initialize       (PlankHideManager *self);
void                plank_hide_manager_update_dock_hovered
                                                        (PlankHideManager *self);
PlankHideManager *  plank_hide_manager_new              (PlankDockController *controller);
gboolean            plank_hide_manager_get_Hidden       (PlankHideManager *self);
gboolean            plank_hide_manager_get_Disabled     (PlankHideManager *self);
gboolean            plank_hide_manager_get_DockHovered  (PlankHideManager *self);
struct              PlankHideManager;
struct              PlankHideManagerClass;
enum                PlankHideType;

Object Hierarchy

  GObject
   +----PlankHideManager
  GEnum
   +----PlankHideType

Properties

  "Disabled"                 gboolean              : Read
  "DockHovered"              gboolean              : Read
  "Hidden"                   gboolean              : Read
  "controller"               PlankDockController*  : Write / Construct Only

Description

Details

PLANK_TYPE_HIDE_MANAGER

#define PLANK_TYPE_HIDE_MANAGER (plank_hide_manager_get_type ())

The type for PlankHideManager.


plank_hide_manager_initialize ()

void                plank_hide_manager_initialize       (PlankHideManager *self);

Initializes the hide manager. Call after the DockWindow is constructed.

self :

the PlankHideManager instance

plank_hide_manager_update_dock_hovered ()

void                plank_hide_manager_update_dock_hovered
                                                        (PlankHideManager *self);

Checks to see if the dock is being hovered by the mouse cursor.

self :

the PlankHideManager instance

plank_hide_manager_new ()

PlankHideManager *  plank_hide_manager_new              (PlankDockController *controller);

Creates a new instance of a HideManager, which handles checking if a dock should hide or not.

controller :

 . the PlankDockController to manage hiding for. [in]

plank_hide_manager_get_Hidden ()

gboolean            plank_hide_manager_get_Hidden       (PlankHideManager *self);

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

If the dock is currently hidden.

self :

the PlankHideManager instance to query

Returns :

the value of the "Hidden" property

plank_hide_manager_get_Disabled ()

gboolean            plank_hide_manager_get_Disabled     (PlankHideManager *self);

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

If hiding the dock is currently disabled

self :

the PlankHideManager instance to query

Returns :

the value of the "Disabled" property

plank_hide_manager_get_DockHovered ()

gboolean            plank_hide_manager_get_DockHovered  (PlankHideManager *self);

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

If the dock is currently hovered by the mouse cursor.

self :

the PlankHideManager instance to query

Returns :

the value of the "DockHovered" property

struct PlankHideManager

struct PlankHideManager;

Class to handle checking if a dock should hide or not.


struct PlankHideManagerClass

struct PlankHideManagerClass {
	GObjectClass parent_class;
};

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

GObjectClass parent_class;

the parent class structure

enum PlankHideType

typedef enum {
	PLANK_HIDE_TYPE_NONE,
	PLANK_HIDE_TYPE_INTELLIGENT,
	PLANK_HIDE_TYPE_AUTO
} PlankHideType;

If/How the dock should hide itself.

PLANK_HIDE_TYPE_NONE

The dock does not hide. It should set struts to reserve space for it.

PLANK_HIDE_TYPE_INTELLIGENT

The dock hides if a window in the active window group overlaps it.

PLANK_HIDE_TYPE_AUTO

The dock hides if the mouse is not over it.

Property Details

The "Disabled" property

  "Disabled"                 gboolean              : Read

If hiding the dock is currently disabled

Default value: FALSE


The "DockHovered" property

  "DockHovered"              gboolean              : Read

If the dock is currently hovered by the mouse cursor.

Default value: FALSE


The "Hidden" property

  "Hidden"                   gboolean              : Read

If the dock is currently hidden.

Default value: TRUE


The "controller" property

  "controller"               PlankDockController*  : Write / Construct Only

controller.