![]() |
![]() |
![]() |
plank Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#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;
"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
#define PLANK_TYPE_DOCK_PREFERENCES (plank_dock_preferences_get_type ())
The type for PlankDockPreferences.
gint plank_dock_preferences_get_monitor (PlankDockPreferences *self
);
Get the actual monitor to place the dock on
|
the PlankDockPreferences instance |
Returns : |
the number of the monitor |
void plank_dock_preferences_increase_icon_size
(PlankDockPreferences *self
);
Increases the IconSize, if it is not already at its max.
|
the PlankDockPreferences instance |
void plank_dock_preferences_decrease_icon_size
(PlankDockPreferences *self
);
Decreases the IconSize, if it is not already at its min.
|
the PlankDockPreferences instance |
gboolean plank_dock_preferences_is_horizontal_dock
(PlankDockPreferences *self
);
Return whether or not a dock is a horizontal dock.
|
the PlankDockPreferences instance |
Returns : |
true if the dock's position indicates it is horizontal |
PlankDockPreferences * plank_dock_preferences_new_with_filename
(const gchar *filename
);
|
gboolean plank_dock_preferences_get_CurrentWorkspaceOnly
(PlankDockPreferences *self
);
Get and return the current value of the "current-workspace-only" property.
|
the PlankDockPreferences instance to query |
Returns : |
the value of the "current-workspace-only" property |
void plank_dock_preferences_set_CurrentWorkspaceOnly (PlankDockPreferences *self
,gboolean value
);
Set the value of the "current-workspace-only" property to value
.
|
the PlankDockPreferences instance to modify |
|
the new value of the "current-workspace-only" property |
gint plank_dock_preferences_get_IconSize (PlankDockPreferences *self
);
Get and return the current value of the "icon-size" property.
|
the PlankDockPreferences instance to query |
Returns : |
the value of the "icon-size" property |
void plank_dock_preferences_set_IconSize (PlankDockPreferences *self
,gint value
);
Set the value of the "icon-size" property to value
.
|
the PlankDockPreferences instance to modify |
|
the new value of the "icon-size" property |
PlankHideType plank_dock_preferences_get_HideMode (PlankDockPreferences *self
);
Get and return the current value of the "hide-mode" property.
|
the PlankDockPreferences instance to query |
Returns : |
the value of the "hide-mode" property |
void plank_dock_preferences_set_HideMode (PlankDockPreferences *self
,PlankHideType value
);
Set the value of the "hide-mode" property to value
.
|
the PlankDockPreferences instance to modify |
|
the new value of the "hide-mode" property |
guint plank_dock_preferences_get_UnhideDelay
(PlankDockPreferences *self
);
Get and return the current value of the "unhide-delay" property.
|
the PlankDockPreferences instance to query |
Returns : |
the value of the "unhide-delay" property |
void plank_dock_preferences_set_UnhideDelay (PlankDockPreferences *self
,guint value
);
Set the value of the "unhide-delay" property to value
.
|
the PlankDockPreferences instance to modify |
|
the new value of the "unhide-delay" property |
gint plank_dock_preferences_get_Monitor (PlankDockPreferences *self
);
Get and return the current value of the "monitor" property.
|
the PlankDockPreferences instance to query |
Returns : |
the value of the "monitor" property |
void plank_dock_preferences_set_Monitor (PlankDockPreferences *self
,gint value
);
Set the value of the "monitor" property to value
.
|
the PlankDockPreferences instance to modify |
|
the new value of the "monitor" property |
const gchar * plank_dock_preferences_get_DockItems
(PlankDockPreferences *self
);
Get and return the current value of the "dock-items" property.
|
the PlankDockPreferences instance to query |
Returns : |
the value of the "dock-items" property |
void plank_dock_preferences_set_DockItems (PlankDockPreferences *self
,const gchar *value
);
Set the value of the "dock-items" property to value
.
|
the PlankDockPreferences instance to modify |
|
the new value of the "dock-items" property |
GtkPositionType plank_dock_preferences_get_Position (PlankDockPreferences *self
);
Get and return the current value of the "position" property.
|
the PlankDockPreferences instance to query |
Returns : |
the value of the "position" property |
void plank_dock_preferences_set_Position (PlankDockPreferences *self
,GtkPositionType value
);
Set the value of the "position" property to value
.
|
the PlankDockPreferences instance to modify |
|
the new value of the "position" property |
gint plank_dock_preferences_get_Offset (PlankDockPreferences *self
);
Get and return the current value of the "offset" property.
|
the PlankDockPreferences instance to query |
Returns : |
the value of the "offset" property |
void plank_dock_preferences_set_Offset (PlankDockPreferences *self
,gint value
);
Set the value of the "offset" property to value
.
|
the PlankDockPreferences instance to modify |
|
the new value of the "offset" property |
const gchar * plank_dock_preferences_get_Theme (PlankDockPreferences *self
);
Get and return the current value of the "theme" property.
|
the PlankDockPreferences instance to query |
Returns : |
the value of the "theme" property |
void plank_dock_preferences_set_Theme (PlankDockPreferences *self
,const gchar *value
);
Set the value of the "theme" property to value
.
|
the PlankDockPreferences instance to modify |
|
the new value of the "theme" property |
GtkAlign plank_dock_preferences_get_Alignment
(PlankDockPreferences *self
);
Get and return the current value of the "alignment" property.
|
the PlankDockPreferences instance to query |
Returns : |
the value of the "alignment" property |
void plank_dock_preferences_set_Alignment (PlankDockPreferences *self
,GtkAlign value
);
Set the value of the "alignment" property to value
.
|
the PlankDockPreferences instance to modify |
|
the new value of the "alignment" property |
GtkAlign plank_dock_preferences_get_ItemsAlignment
(PlankDockPreferences *self
);
Get and return the current value of the "items-alignment" property.
|
the PlankDockPreferences instance to query |
Returns : |
the value of the "items-alignment" property |
void plank_dock_preferences_set_ItemsAlignment (PlankDockPreferences *self
,GtkAlign value
);
Set the value of the "items-alignment" property to value
.
|
the PlankDockPreferences instance to modify |
|
the new value of the "items-alignment" property |
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 |
the parent class structure |
"Alignment"
property"Alignment" GtkAlign : Read / Write
The alignment for the dock on the monitor's edge.
Default value: GTK_ALIGN_FILL
"CurrentWorkspaceOnly"
property"CurrentWorkspaceOnly" gboolean : Read / Write
Whether to show only windows of the current workspace.
Default value: FALSE
"DockItems"
property"DockItems" gchar* : Read / Write
List of *.dockitem files on this dock. DO NOT MODIFY.
Default value: NULL
"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
"IconSize"
property"IconSize" gint : Read / Write
The size of dock icons (in pixels).
Default value: 0
"ItemsAlignment"
property"ItemsAlignment" GtkAlign : Read / Write
The alignment of the items in this dock.
Default value: GTK_ALIGN_FILL
"Monitor"
property"Monitor" gint : Read / Write
The monitor number for the dock. Use -1 to keep on the primary monitor.
Default value: 0
"Offset"
property"Offset" gint : Read / Write
The dock's position offset from center (in percent).
Default value: 0
"Position"
property"Position" GtkPositionType : Read / Write
The position for the dock on the monitor.
Default value: GTK_POS_LEFT
"Theme"
property"Theme" gchar* : Read / Write
The name of the dock's theme to use.
Default value: NULL
"UnhideDelay"
property"UnhideDelay" guint : Read / Write
Time (in ms) to wait before unhiding the dock.
Default value: 0