PlankDockPreferences

PlankDockPreferences — Contains all preferences for docks.

Synopsis

#define             PLANK_TYPE_DOCK_PREFERENCES
gint                plank_dock_preferences_get_monitor  (PlankDockPreferences *self);
void                plank_dock_preferences_increase_icon_size
                                                        (PlankDockPreferences *self);
void                plank_dock_preferences_decrease_icon_size
                                                        (PlankDockPreferences *self);
gboolean            plank_dock_preferences_is_horizontal_dock
                                                        (PlankDockPreferences *self);
#define             PLANK_DOCK_PREFERENCES_MIN_ICON_SIZE
#define             PLANK_DOCK_PREFERENCES_MAX_ICON_SIZE
PlankDockPreferences * plank_dock_preferences_new       (void);
PlankDockPreferences * plank_dock_preferences_new_with_filename
                                                        (const gchar *filename);
gboolean            plank_dock_preferences_get_CurrentWorkspaceOnly
                                                        (PlankDockPreferences *self);
void                plank_dock_preferences_set_CurrentWorkspaceOnly
                                                        (PlankDockPreferences *self,
                                                         gboolean value);
gint                plank_dock_preferences_get_IconSize (PlankDockPreferences *self);
void                plank_dock_preferences_set_IconSize (PlankDockPreferences *self,
                                                         gint value);
PlankHideType       plank_dock_preferences_get_HideMode (PlankDockPreferences *self);
void                plank_dock_preferences_set_HideMode (PlankDockPreferences *self,
                                                         PlankHideType value);
guint               plank_dock_preferences_get_UnhideDelay
                                                        (PlankDockPreferences *self);
void                plank_dock_preferences_set_UnhideDelay
                                                        (PlankDockPreferences *self,
                                                         guint value);
gint                plank_dock_preferences_get_Monitor  (PlankDockPreferences *self);
void                plank_dock_preferences_set_Monitor  (PlankDockPreferences *self,
                                                         gint value);
const gchar *       plank_dock_preferences_get_DockItems
                                                        (PlankDockPreferences *self);
void                plank_dock_preferences_set_DockItems
                                                        (PlankDockPreferences *self,
                                                         const gchar *value);
GtkPositionType     plank_dock_preferences_get_Position (PlankDockPreferences *self);
void                plank_dock_preferences_set_Position (PlankDockPreferences *self,
                                                         GtkPositionType value);
gint                plank_dock_preferences_get_Offset   (PlankDockPreferences *self);
void                plank_dock_preferences_set_Offset   (PlankDockPreferences *self,
                                                         gint value);
const gchar *       plank_dock_preferences_get_Theme    (PlankDockPreferences *self);
void                plank_dock_preferences_set_Theme    (PlankDockPreferences *self,
                                                         const gchar *value);
GtkAlign            plank_dock_preferences_get_Alignment
                                                        (PlankDockPreferences *self);
void                plank_dock_preferences_set_Alignment
                                                        (PlankDockPreferences *self,
                                                         GtkAlign value);
GtkAlign            plank_dock_preferences_get_ItemsAlignment
                                                        (PlankDockPreferences *self);
void                plank_dock_preferences_set_ItemsAlignment
                                                        (PlankDockPreferences *self,
                                                         GtkAlign value);
struct              PlankDockPreferences;
struct              PlankDockPreferencesClass;

Object Hierarchy

  GObject
   +----PlankServicesPreferences
         +----PlankDockPreferences

Properties

  "Alignment"                GtkAlign              : Read / Write
  "CurrentWorkspaceOnly"     gboolean              : Read / Write
  "DockItems"                gchar*                : Read / Write
  "HideMode"                 PlankHideType         : Read / Write
  "IconSize"                 gint                  : Read / Write
  "ItemsAlignment"           GtkAlign              : Read / Write
  "Monitor"                  gint                  : Read / Write
  "Offset"                   gint                  : Read / Write
  "Position"                 GtkPositionType       : Read / Write
  "Theme"                    gchar*                : Read / Write
  "UnhideDelay"              guint                 : Read / Write

Description

Details

PLANK_TYPE_DOCK_PREFERENCES

#define PLANK_TYPE_DOCK_PREFERENCES (plank_dock_preferences_get_type ())

The type for PlankDockPreferences.


plank_dock_preferences_get_monitor ()

gint                plank_dock_preferences_get_monitor  (PlankDockPreferences *self);

Get the actual monitor to place the dock on

self :

the PlankDockPreferences instance

Returns :

the number of the monitor

plank_dock_preferences_increase_icon_size ()

void                plank_dock_preferences_increase_icon_size
                                                        (PlankDockPreferences *self);

Increases the IconSize, if it is not already at its max.

self :

the PlankDockPreferences instance

plank_dock_preferences_decrease_icon_size ()

void                plank_dock_preferences_decrease_icon_size
                                                        (PlankDockPreferences *self);

Decreases the IconSize, if it is not already at its min.

self :

the PlankDockPreferences instance

plank_dock_preferences_is_horizontal_dock ()

gboolean            plank_dock_preferences_is_horizontal_dock
                                                        (PlankDockPreferences *self);

Return whether or not a dock is a horizontal dock.

self :

the PlankDockPreferences instance

Returns :

true if the dock's position indicates it is horizontal

PLANK_DOCK_PREFERENCES_MIN_ICON_SIZE

#define PLANK_DOCK_PREFERENCES_MIN_ICON_SIZE 24

PLANK_DOCK_PREFERENCES_MAX_ICON_SIZE

#define PLANK_DOCK_PREFERENCES_MAX_ICON_SIZE 128

plank_dock_preferences_new ()

PlankDockPreferences * plank_dock_preferences_new       (void);

plank_dock_preferences_new_with_filename ()

PlankDockPreferences * plank_dock_preferences_new_with_filename
                                                        (const gchar *filename);

filename :

 

plank_dock_preferences_get_CurrentWorkspaceOnly ()

gboolean            plank_dock_preferences_get_CurrentWorkspaceOnly
                                                        (PlankDockPreferences *self);

Get and return the current value of the "current-workspace-only" property.

self :

the PlankDockPreferences instance to query

Returns :

the value of the "current-workspace-only" property

plank_dock_preferences_set_CurrentWorkspaceOnly ()

void                plank_dock_preferences_set_CurrentWorkspaceOnly
                                                        (PlankDockPreferences *self,
                                                         gboolean value);

Set the value of the "current-workspace-only" property to value.

self :

the PlankDockPreferences instance to modify

value :

the new value of the "current-workspace-only" property

plank_dock_preferences_get_IconSize ()

gint                plank_dock_preferences_get_IconSize (PlankDockPreferences *self);

Get and return the current value of the "icon-size" property.

self :

the PlankDockPreferences instance to query

Returns :

the value of the "icon-size" property

plank_dock_preferences_set_IconSize ()

void                plank_dock_preferences_set_IconSize (PlankDockPreferences *self,
                                                         gint value);

Set the value of the "icon-size" property to value.

self :

the PlankDockPreferences instance to modify

value :

the new value of the "icon-size" property

plank_dock_preferences_get_HideMode ()

PlankHideType       plank_dock_preferences_get_HideMode (PlankDockPreferences *self);

Get and return the current value of the "hide-mode" property.

self :

the PlankDockPreferences instance to query

Returns :

the value of the "hide-mode" property

plank_dock_preferences_set_HideMode ()

void                plank_dock_preferences_set_HideMode (PlankDockPreferences *self,
                                                         PlankHideType value);

Set the value of the "hide-mode" property to value.

self :

the PlankDockPreferences instance to modify

value :

the new value of the "hide-mode" property

plank_dock_preferences_get_UnhideDelay ()

guint               plank_dock_preferences_get_UnhideDelay
                                                        (PlankDockPreferences *self);

Get and return the current value of the "unhide-delay" property.

self :

the PlankDockPreferences instance to query

Returns :

the value of the "unhide-delay" property

plank_dock_preferences_set_UnhideDelay ()

void                plank_dock_preferences_set_UnhideDelay
                                                        (PlankDockPreferences *self,
                                                         guint value);

Set the value of the "unhide-delay" property to value.

self :

the PlankDockPreferences instance to modify

value :

the new value of the "unhide-delay" property

plank_dock_preferences_get_Monitor ()

gint                plank_dock_preferences_get_Monitor  (PlankDockPreferences *self);

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

self :

the PlankDockPreferences instance to query

Returns :

the value of the "monitor" property

plank_dock_preferences_set_Monitor ()

void                plank_dock_preferences_set_Monitor  (PlankDockPreferences *self,
                                                         gint value);

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

self :

the PlankDockPreferences instance to modify

value :

the new value of the "monitor" property

plank_dock_preferences_get_DockItems ()

const gchar *       plank_dock_preferences_get_DockItems
                                                        (PlankDockPreferences *self);

Get and return the current value of the "dock-items" property.

self :

the PlankDockPreferences instance to query

Returns :

the value of the "dock-items" property

plank_dock_preferences_set_DockItems ()

void                plank_dock_preferences_set_DockItems
                                                        (PlankDockPreferences *self,
                                                         const gchar *value);

Set the value of the "dock-items" property to value.

self :

the PlankDockPreferences instance to modify

value :

the new value of the "dock-items" property

plank_dock_preferences_get_Position ()

GtkPositionType     plank_dock_preferences_get_Position (PlankDockPreferences *self);

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

self :

the PlankDockPreferences instance to query

Returns :

the value of the "position" property

plank_dock_preferences_set_Position ()

void                plank_dock_preferences_set_Position (PlankDockPreferences *self,
                                                         GtkPositionType value);

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

self :

the PlankDockPreferences instance to modify

value :

the new value of the "position" property

plank_dock_preferences_get_Offset ()

gint                plank_dock_preferences_get_Offset   (PlankDockPreferences *self);

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

self :

the PlankDockPreferences instance to query

Returns :

the value of the "offset" property

plank_dock_preferences_set_Offset ()

void                plank_dock_preferences_set_Offset   (PlankDockPreferences *self,
                                                         gint value);

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

self :

the PlankDockPreferences instance to modify

value :

the new value of the "offset" property

plank_dock_preferences_get_Theme ()

const gchar *       plank_dock_preferences_get_Theme    (PlankDockPreferences *self);

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

self :

the PlankDockPreferences instance to query

Returns :

the value of the "theme" property

plank_dock_preferences_set_Theme ()

void                plank_dock_preferences_set_Theme    (PlankDockPreferences *self,
                                                         const gchar *value);

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

self :

the PlankDockPreferences instance to modify

value :

the new value of the "theme" property

plank_dock_preferences_get_Alignment ()

GtkAlign            plank_dock_preferences_get_Alignment
                                                        (PlankDockPreferences *self);

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

self :

the PlankDockPreferences instance to query

Returns :

the value of the "alignment" property

plank_dock_preferences_set_Alignment ()

void                plank_dock_preferences_set_Alignment
                                                        (PlankDockPreferences *self,
                                                         GtkAlign value);

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

self :

the PlankDockPreferences instance to modify

value :

the new value of the "alignment" property

plank_dock_preferences_get_ItemsAlignment ()

GtkAlign            plank_dock_preferences_get_ItemsAlignment
                                                        (PlankDockPreferences *self);

Get and return the current value of the "items-alignment" property.

self :

the PlankDockPreferences instance to query

Returns :

the value of the "items-alignment" property

plank_dock_preferences_set_ItemsAlignment ()

void                plank_dock_preferences_set_ItemsAlignment
                                                        (PlankDockPreferences *self,
                                                         GtkAlign value);

Set the value of the "items-alignment" property to value.

self :

the PlankDockPreferences instance to modify

value :

the new value of the "items-alignment" property

struct PlankDockPreferences

struct PlankDockPreferences;

Contains all preferences for docks.


struct PlankDockPreferencesClass

struct PlankDockPreferencesClass {
	PlankServicesPreferencesClass parent_class;
};

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

PlankServicesPreferencesClass parent_class;

the parent class structure

Property Details

The "Alignment" property

  "Alignment"                GtkAlign              : Read / Write

The alignment for the dock on the monitor's edge.

Default value: GTK_ALIGN_FILL


The "CurrentWorkspaceOnly" property

  "CurrentWorkspaceOnly"     gboolean              : Read / Write

Whether to show only windows of the current workspace.

Default value: FALSE


The "DockItems" property

  "DockItems"                gchar*                : Read / Write

List of *.dockitem files on this dock. DO NOT MODIFY.

Default value: NULL


The "HideMode" property

  "HideMode"                 PlankHideType         : Read / Write

If 0, the dock won't hide. If 1, the dock intelligently hides. If 2, the dock auto-hides.

Default value: PLANK_HIDE_TYPE_NONE


The "IconSize" property

  "IconSize"                 gint                  : Read / Write

The size of dock icons (in pixels).

Default value: 0


The "ItemsAlignment" property

  "ItemsAlignment"           GtkAlign              : Read / Write

The alignment of the items in this dock.

Default value: GTK_ALIGN_FILL


The "Monitor" property

  "Monitor"                  gint                  : Read / Write

The monitor number for the dock. Use -1 to keep on the primary monitor.

Default value: 0


The "Offset" property

  "Offset"                   gint                  : Read / Write

The dock's position offset from center (in percent).

Default value: 0


The "Position" property

  "Position"                 GtkPositionType       : Read / Write

The position for the dock on the monitor.

Default value: GTK_POS_LEFT


The "Theme" property

  "Theme"                    gchar*                : Read / Write

The name of the dock's theme to use.

Default value: NULL


The "UnhideDelay" property

  "UnhideDelay"              guint                 : Read / Write

Time (in ms) to wait before unhiding the dock.

Default value: 0