![]() |
![]() |
![]() |
plank Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties | Signals |
PlankItemsDockItemProviderPlankItemsDockItemProvider — A container and controller class for managing dock items on a dock. |
#define PLANK_ITEMS_TYPE_DOCK_ITEM_PROVIDER void plank_items_dock_item_provider_add_item (PlankItemsDockItemProvider *self
,PlankItemsDockItem *item
); void plank_items_dock_item_provider_remove_item (PlankItemsDockItemProvider *self
,PlankItemsDockItem *item
); void plank_items_dock_item_provider_handle_item_state_changed (PlankItemsDockItemProvider *self
); void plank_items_dock_item_provider_update_visible_items (PlankItemsDockItemProvider *self
); void plank_items_dock_item_provider_set_item_positions (PlankItemsDockItemProvider *self
); void plank_items_dock_item_provider_handle_setting_changed (PlankItemsDockItemProvider *self
); void plank_items_dock_item_provider_save_item_positions (PlankItemsDockItemProvider *self
); void plank_items_dock_item_provider_restore_item_positions (PlankItemsDockItemProvider *self
); void plank_items_dock_item_provider_move_item_to (PlankItemsDockItemProvider *self
,PlankItemsDockItem *move
,PlankItemsDockItem *target
); void plank_items_dock_item_provider_reset_item_buffers (PlankItemsDockItemProvider *self
); void plank_items_dock_item_provider_add_item_without_signaling (PlankItemsDockItemProvider *self
,PlankItemsDockItem *item
); void plank_items_dock_item_provider_replace_item (PlankItemsDockItemProvider *self
,PlankItemsDockItem *new_item
,PlankItemsDockItem *old_item
); void plank_items_dock_item_provider_remove_item_without_signaling (PlankItemsDockItemProvider *self
,PlankItemsDockItem *item
); void plank_items_dock_item_provider_item_signals_connect (PlankItemsDockItemProvider *self
,PlankItemsDockItem *item
); void plank_items_dock_item_provider_item_signals_disconnect (PlankItemsDockItemProvider *self
,PlankItemsDockItem *item
); void plank_items_dock_item_provider_handle_item_deleted (PlankItemsDockItemProvider *self
,PlankItemsDockItem *item
); PlankItemsDockItemProvider * plank_items_dock_item_provider_new (void
); GeeArrayList * plank_items_dock_item_provider_get_Items (PlankItemsDockItemProvider *self
); gint plank_items_dock_item_provider_compare_items (PlankItemsDockItem *left
,PlankItemsDockItem *right
); struct PlankItemsDockItemProvider; struct PlankItemsDockItemProviderClass;
"item-position-changed" :Run Last
"item-state-changed" :Run Last
"items-changed" :Run Last
#define PLANK_ITEMS_TYPE_DOCK_ITEM_PROVIDER (plank_items_dock_item_provider_get_type ())
The type for PlankItemsDockItemProvider.
void plank_items_dock_item_provider_add_item (PlankItemsDockItemProvider *self
,PlankItemsDockItem *item
);
Adds a dock item to the collection.
|
the PlankItemsDockItemProvider instance |
|
. the dock item to add. [in] |
void plank_items_dock_item_provider_remove_item (PlankItemsDockItemProvider *self
,PlankItemsDockItem *item
);
Removes a dock item from the collection.
|
the PlankItemsDockItemProvider instance |
|
. the dock item to remove. [in] |
void plank_items_dock_item_provider_handle_item_state_changed
(PlankItemsDockItemProvider *self
);
|
the PlankItemsDockItemProvider instance |
void plank_items_dock_item_provider_update_visible_items
(PlankItemsDockItemProvider *self
);
|
the PlankItemsDockItemProvider instance |
void plank_items_dock_item_provider_set_item_positions
(PlankItemsDockItemProvider *self
);
|
the PlankItemsDockItemProvider instance |
void plank_items_dock_item_provider_handle_setting_changed
(PlankItemsDockItemProvider *self
);
|
the PlankItemsDockItemProvider instance |
void plank_items_dock_item_provider_save_item_positions
(PlankItemsDockItemProvider *self
);
Save current item positions
|
the PlankItemsDockItemProvider instance |
void plank_items_dock_item_provider_restore_item_positions
(PlankItemsDockItemProvider *self
);
Restore previously saved item positions
|
the PlankItemsDockItemProvider instance |
void plank_items_dock_item_provider_move_item_to (PlankItemsDockItemProvider *self
,PlankItemsDockItem *move
,PlankItemsDockItem *target
);
Move an item to the position of another item. This shifts all items which are between these two items.
|
the PlankItemsDockItemProvider instance |
|
. the item to move. [in] |
|
. the item of the new position. [in] |
void plank_items_dock_item_provider_reset_item_buffers
(PlankItemsDockItemProvider *self
);
Reset internal buffers of all items.
|
the PlankItemsDockItemProvider instance |
void plank_items_dock_item_provider_add_item_without_signaling (PlankItemsDockItemProvider *self
,PlankItemsDockItem *item
);
|
the PlankItemsDockItemProvider instance |
|
void plank_items_dock_item_provider_replace_item (PlankItemsDockItemProvider *self
,PlankItemsDockItem *new_item
,PlankItemsDockItem *old_item
);
Replace an item with another item.
|
the PlankItemsDockItemProvider instance |
|
. the new item. [in] |
|
. the item to be replaced. [in] |
void plank_items_dock_item_provider_remove_item_without_signaling (PlankItemsDockItemProvider *self
,PlankItemsDockItem *item
);
|
the PlankItemsDockItemProvider instance |
|
void plank_items_dock_item_provider_item_signals_connect (PlankItemsDockItemProvider *self
,PlankItemsDockItem *item
);
|
the PlankItemsDockItemProvider instance |
|
void plank_items_dock_item_provider_item_signals_disconnect (PlankItemsDockItemProvider *self
,PlankItemsDockItem *item
);
|
the PlankItemsDockItemProvider instance |
|
void plank_items_dock_item_provider_handle_item_deleted (PlankItemsDockItemProvider *self
,PlankItemsDockItem *item
);
|
the PlankItemsDockItemProvider instance |
|
PlankItemsDockItemProvider * plank_items_dock_item_provider_new
(void
);
Creates a new container for dock items.
GeeArrayList * plank_items_dock_item_provider_get_Items
(PlankItemsDockItemProvider *self
);
Get and return the current value of the "Items" property.
A list of the dock items.
|
the PlankItemsDockItemProvider instance to query |
Returns : |
the value of the "Items" property |
gint plank_items_dock_item_provider_compare_items (PlankItemsDockItem *left
,PlankItemsDockItem *right
);
|
|
|
struct PlankItemsDockItemProvider;
A container and controller class for managing dock items on a dock.
struct PlankItemsDockItemProviderClass { GObjectClass parent_class; void (*update_visible_items) (PlankItemsDockItemProvider* self); void (*move_item_to) (PlankItemsDockItemProvider* self, PlankItemsDockItem* move, PlankItemsDockItem* target); void (*add_item_without_signaling) (PlankItemsDockItemProvider* self, PlankItemsDockItem* item); void (*replace_item) (PlankItemsDockItemProvider* self, PlankItemsDockItem* new_item, PlankItemsDockItem* old_item); void (*remove_item_without_signaling) (PlankItemsDockItemProvider* self, PlankItemsDockItem* item); void (*item_signals_connect) (PlankItemsDockItemProvider* self, PlankItemsDockItem* item); void (*item_signals_disconnect) (PlankItemsDockItemProvider* self, PlankItemsDockItem* item); void (*handle_item_deleted) (PlankItemsDockItemProvider* self, PlankItemsDockItem* item); };
The class structure for PLANK_ITEMS_TYPE_DOCK_ITEM_PROVIDER
. All the fields in this structure are private and should never be accessed directly.
GObjectClass |
the parent class structure |
virtual method used internally | |
virtual method called by plank_items_dock_item_provider_move_item_to()
|
|
virtual method used internally | |
virtual method called by plank_items_dock_item_provider_replace_item()
|
|
virtual method used internally | |
virtual method used internally | |
virtual method used internally | |
virtual method used internally |
"item-position-changed"
signalvoid user_function (PlankItemsDockItemProvider *dock_item_provider,
gpointer user_data) : Run Last
Triggered anytime an item's Position changes.
|
the PlankItemsDockItemProvider instance that received the signal |
|
user data set when the signal handler was connected. |
"item-state-changed"
signalvoid user_function (PlankItemsDockItemProvider *dock_item_provider,
gpointer user_data) : Run Last
Triggered when the state of an item changes.
|
the PlankItemsDockItemProvider instance that received the signal |
|
user data set when the signal handler was connected. |
"items-changed"
signalvoid user_function (PlankItemsDockItemProvider *dock_item_provider,
GeeList *added,
GeeList *removed,
gpointer user_data) : Run Last
Triggered when the items collection has changed.
|
the PlankItemsDockItemProvider instance that received the signal |
|
. the list of added items |
|
. the list of removed items |
|
user data set when the signal handler was connected. |