PlankItemsDockItemProvider

PlankItemsDockItemProvider — A container and controller class for managing dock items on a dock.

Synopsis

#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;

Object Hierarchy

  GObject
   +----PlankItemsDockItemProvider
         +----PlankItemsApplicationDockItemProvider

Properties

  "Items"                    GeeArrayList*         : Read

Signals

  "item-position-changed"                          : Run Last
  "item-state-changed"                             : Run Last
  "items-changed"                                  : Run Last

Description

Details

PLANK_ITEMS_TYPE_DOCK_ITEM_PROVIDER

#define PLANK_ITEMS_TYPE_DOCK_ITEM_PROVIDER (plank_items_dock_item_provider_get_type ())

The type for PlankItemsDockItemProvider.


plank_items_dock_item_provider_add_item ()

void                plank_items_dock_item_provider_add_item
                                                        (PlankItemsDockItemProvider *self,
                                                         PlankItemsDockItem *item);

Adds a dock item to the collection.

self :

the PlankItemsDockItemProvider instance

item :

 . the dock item to add. [in]

plank_items_dock_item_provider_remove_item ()

void                plank_items_dock_item_provider_remove_item
                                                        (PlankItemsDockItemProvider *self,
                                                         PlankItemsDockItem *item);

Removes a dock item from the collection.

self :

the PlankItemsDockItemProvider instance

item :

 . the dock item to remove. [in]

plank_items_dock_item_provider_handle_item_state_changed ()

void                plank_items_dock_item_provider_handle_item_state_changed
                                                        (PlankItemsDockItemProvider *self);

self :

the PlankItemsDockItemProvider instance

plank_items_dock_item_provider_update_visible_items ()

void                plank_items_dock_item_provider_update_visible_items
                                                        (PlankItemsDockItemProvider *self);

self :

the PlankItemsDockItemProvider instance

plank_items_dock_item_provider_set_item_positions ()

void                plank_items_dock_item_provider_set_item_positions
                                                        (PlankItemsDockItemProvider *self);

self :

the PlankItemsDockItemProvider instance

plank_items_dock_item_provider_handle_setting_changed ()

void                plank_items_dock_item_provider_handle_setting_changed
                                                        (PlankItemsDockItemProvider *self);

self :

the PlankItemsDockItemProvider instance

plank_items_dock_item_provider_save_item_positions ()

void                plank_items_dock_item_provider_save_item_positions
                                                        (PlankItemsDockItemProvider *self);

Save current item positions

self :

the PlankItemsDockItemProvider instance

plank_items_dock_item_provider_restore_item_positions ()

void                plank_items_dock_item_provider_restore_item_positions
                                                        (PlankItemsDockItemProvider *self);

Restore previously saved item positions

self :

the PlankItemsDockItemProvider instance

plank_items_dock_item_provider_move_item_to ()

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.

self :

the PlankItemsDockItemProvider instance

move :

 . the item to move. [in]

target :

 . the item of the new position. [in]

plank_items_dock_item_provider_reset_item_buffers ()

void                plank_items_dock_item_provider_reset_item_buffers
                                                        (PlankItemsDockItemProvider *self);

Reset internal buffers of all items.

self :

the PlankItemsDockItemProvider instance

plank_items_dock_item_provider_add_item_without_signaling ()

void                plank_items_dock_item_provider_add_item_without_signaling
                                                        (PlankItemsDockItemProvider *self,
                                                         PlankItemsDockItem *item);

self :

the PlankItemsDockItemProvider instance

item :

 

plank_items_dock_item_provider_replace_item ()

void                plank_items_dock_item_provider_replace_item
                                                        (PlankItemsDockItemProvider *self,
                                                         PlankItemsDockItem *new_item,
                                                         PlankItemsDockItem *old_item);

Replace an item with another item.

self :

the PlankItemsDockItemProvider instance

new_item :

 . the new item. [in]

old_item :

 . the item to be replaced. [in]

plank_items_dock_item_provider_remove_item_without_signaling ()

void                plank_items_dock_item_provider_remove_item_without_signaling
                                                        (PlankItemsDockItemProvider *self,
                                                         PlankItemsDockItem *item);

self :

the PlankItemsDockItemProvider instance

item :

 

plank_items_dock_item_provider_item_signals_connect ()

void                plank_items_dock_item_provider_item_signals_connect
                                                        (PlankItemsDockItemProvider *self,
                                                         PlankItemsDockItem *item);

self :

the PlankItemsDockItemProvider instance

item :

 

plank_items_dock_item_provider_item_signals_disconnect ()

void                plank_items_dock_item_provider_item_signals_disconnect
                                                        (PlankItemsDockItemProvider *self,
                                                         PlankItemsDockItem *item);

self :

the PlankItemsDockItemProvider instance

item :

 

plank_items_dock_item_provider_handle_item_deleted ()

void                plank_items_dock_item_provider_handle_item_deleted
                                                        (PlankItemsDockItemProvider *self,
                                                         PlankItemsDockItem *item);

self :

the PlankItemsDockItemProvider instance

item :

 

plank_items_dock_item_provider_new ()

PlankItemsDockItemProvider * plank_items_dock_item_provider_new
                                                        (void);

Creates a new container for dock items.


plank_items_dock_item_provider_get_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.

self :

the PlankItemsDockItemProvider instance to query

Returns :

the value of the "Items" property

plank_items_dock_item_provider_compare_items ()

gint                plank_items_dock_item_provider_compare_items
                                                        (PlankItemsDockItem *left,
                                                         PlankItemsDockItem *right);

left :

 

right :

 

struct PlankItemsDockItemProvider

struct PlankItemsDockItemProvider;

A container and controller class for managing dock items on a dock.


struct PlankItemsDockItemProviderClass

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 parent_class;

the parent class structure

update_visible_items ()

virtual method used internally

move_item_to ()

virtual method called by plank_items_dock_item_provider_move_item_to()

add_item_without_signaling ()

virtual method used internally

replace_item ()

virtual method called by plank_items_dock_item_provider_replace_item()

remove_item_without_signaling ()

virtual method used internally

item_signals_connect ()

virtual method used internally

item_signals_disconnect ()

virtual method used internally

handle_item_deleted ()

virtual method used internally

Property Details

The "Items" property

  "Items"                    GeeArrayList*         : Read

A list of the dock items.

Signal Details

The "item-position-changed" signal

void                user_function                      (PlankItemsDockItemProvider *dock_item_provider,
                                                        gpointer                    user_data)               : Run Last

Triggered anytime an item's Position changes.

dock_item_provider :

the PlankItemsDockItemProvider instance that received the signal

user_data :

user data set when the signal handler was connected.

The "item-state-changed" signal

void                user_function                      (PlankItemsDockItemProvider *dock_item_provider,
                                                        gpointer                    user_data)               : Run Last

Triggered when the state of an item changes.

dock_item_provider :

the PlankItemsDockItemProvider instance that received the signal

user_data :

user data set when the signal handler was connected.

The "items-changed" signal

void                user_function                      (PlankItemsDockItemProvider *dock_item_provider,
                                                        GeeList                    *added,
                                                        GeeList                    *removed,
                                                        gpointer                    user_data)               : Run Last

Triggered when the items collection has changed.

dock_item_provider :

the PlankItemsDockItemProvider instance that received the signal

added :

 . the list of added items

removed :

 . the list of removed items

user_data :

user data set when the signal handler was connected.