DockItem
Object Hierarchy:
Description:
public class DockItem : Object
The base class for all dock items.
Content:
Properties:
- public
string
Icon { set; get; }
The dock item's icon.
- protected
Pixbuf
? ForcePixbuf { public set; public get; }
- public
string
Text { set; get; }
The dock item's text.
- public
int64
Count { set; get; }
The count for the dock item.
- public
bool
CountVisible { set; get; }
Show the item's count or not.
- public
double
Progress { set; get; }
The progress for this dock item.
- public
bool
ProgressVisible { set; get; }
Show the item's progress or not.
- public
int
Position { set; get; }
The dock item's position on the dock.
- public
bool
IsVisible { set; get; }
Wether the item is currently visible on the dock.
- public PopupButton Button { protected set; get; }
The buttons this item shows popup menus for.
- public ItemState State { protected set; get; }
The item's current state.
- public IndicatorState Indicator { protected set; get; }
The indicator shown for the item.
- public ClickAnimation ClickedAnimation { protected set; get; }
The animation to show for the item's last click event.
- public
DateTime
AddTime { set; get; }
The time the item was added to the dock.
- public
DateTime
RemoveTime { set; get; }
The time the item was removed from the dock.
- public
DateTime
LastClicked { protected set; get; }
The last time the item was clicked.
- public
DateTime
LastScrolled { protected set; get; }
The last time the item was scrolled.
- public
DateTime
LastUrgent { protected set; get; }
The last time the item changed its urgent status.
- public
DateTime
LastActive { protected set; get; }
The last time the item changed its active status.
- public virtual
bool
ValidItem { get; }
Whether or not this item is valid for the .dockitem given.
- public Color AverageIconColor { protected set; get; }
The average color of this item's icon.
- public
string
DockItemFilename { owned get; }
The filename of the preferences backing file.
- public
string
Launcher { get; }
The launcher associated with this item.
- public DockItemPreferences Prefs { construct set; get; }
The underlying preferences for this item.
Static methods:
- protected static
MenuItem
create_menu_item (string
title, string
icon)
Creates a new menu item.
Creation methods:
- public DockItem ()
Creates a new dock item.
Methods:
- protected void handle_deleted ()
Signal handler called when the underlying preferences file is
deleted.
- public void @delete ()
Deletes the underlying preferences file.
- protected void reset_icon_buffer ()
Resets the buffer for this item's icon and requests a redraw.
- public void reset_buffers ()
Resets the buffers for this item's icon.
- public weak DockSurface? get_background_surface (DrawItemFunc? draw_func = null)
Returns the background surface for this item.
- public weak DockSurface? get_foreground_surface (DrawItemFunc? draw_func = null)
Returns the foreground surface for this item.
- public DockSurface get_surface_copy (
int
width, int
height, DockSurface model)
Returns a copy of the dock surface for this item.
- protected virtual void draw_icon (DockSurface surface)
Draws the item's icon onto a surface.
- public void clicked (PopupButton button,
ModifierType
mod)
Called when an item is clicked on.
- protected virtual ClickAnimation on_clicked (PopupButton button,
ModifierType
mod)
Called when an item is clicked on.
- public void scrolled (
ScrollDirection
direction, ModifierType
mod)
Called when an item is scrolled over.
- protected virtual void on_scrolled (
ScrollDirection
direction, ModifierType
mod)
Called when an item is scrolled over.
- public virtual
ArrayList
<MenuItem
> get_menu_items ()
Returns a list of the item's menu items.
- public virtual
bool
can_be_removed ()
Returns if this item can be removed from the dock.
- public virtual
bool
can_accept_drop (ArrayList
<string
> uris)
Returns if the item accepts a drop of the given URIs.
- public virtual
bool
accept_drop (ArrayList
<string
> uris)
Accepts a drop of the given URIs.
- public virtual
string
unique_id ()
Returns a unique ID for this dock item.
- public
string
as_uri ()
Returns a unique URI for this dock item.
- public void copy_values_to (DockItem target)
Copy all property value of this dockitem instance to target
instance.
Signals:
- public signal void deleted ()
Signal fired when the .dockitem for this item was deleted.
- public signal void launcher_changed ()
Signal fired when the launcher associated with the dock item
changed.
- public signal void needs_redraw ()
Signal fired when the dock item needs redrawn.
Inherited Members:
All known members inherited from class GLib.Object
- @new
- newv
- new_valist
- get_type
- get_class
- @ref
- unref
- ref_sink
- weak_ref
- weak_unref
- add_weak_pointer
- remove_weak_pointer
- @get
- @set
- get_property
- set_property
- get_data
- set_data
- set_data_full
- steal_data
- get_qdata
- set_qdata
- set_qdata_full
- steal_qdata
- freeze_notify
- thaw_notify
- dispose
- constructed
- notify_property
- connect
- disconnect
- add_toggle_ref
- remove_toggle_ref
- bind_property
- notify
- ref_count