NAObjectId

NAObjectId

Synopsis

#define             NA_OBJECT_ID_TYPE
typedef             NAObjectIdPrivate;
typedef             NAObjectIdClassPrivate;
                    NAObjectId;
gint                na_object_id_sort_alpha_asc         (const NAObjectId *a,
                                                         const NAObjectId *b);
gint                na_object_id_sort_alpha_desc        (const NAObjectId *a,
                                                         const NAObjectId *b);
void                na_object_id_prepare_for_paste      (NAObjectId *object,
                                                         gboolean relabel,
                                                         gboolean renumber,
                                                         NAObjectId *parent);
void                na_object_id_set_copy_of_label      (NAObjectId *object);
void                na_object_id_set_new_id             (NAObjectId *object,
                                                         const NAObjectId *new_parent);

Object Hierarchy

  GObject
   +----NAObject
         +----NAObjectId
               +----NAObjectItem
               +----NAObjectProfile

Implemented Interfaces

NAObjectId implements NAIDuplicable.

Description

Details

NA_OBJECT_ID_TYPE

#define NA_OBJECT_ID_TYPE					( na_object_id_get_type())


NAObjectIdPrivate

typedef struct NAObjectIdPrivate      NAObjectIdPrivate;


NAObjectIdClassPrivate

typedef struct NAObjectIdClassPrivate NAObjectIdClassPrivate;


NAObjectId

typedef struct _NAObjectId NAObjectId;


na_object_id_sort_alpha_asc ()

gint                na_object_id_sort_alpha_asc         (const NAObjectId *a,
                                                         const NAObjectId *b);

Sort the objects in alphabetical ascending order of their label.

a :

first NAObjectId.

b :

second NAObjectId.

Returns :

-1 if a must be sorted before b, 0 if a and b are equal from the local point of view, 1 if a must be sorted after b.

na_object_id_sort_alpha_desc ()

gint                na_object_id_sort_alpha_desc        (const NAObjectId *a,
                                                         const NAObjectId *b);

Sort the objects in alphabetical descending order of their label.

a :

first NAObjectId.

b :

second NAObjectId.

Returns :

-1 if a must be sorted before b, 0 if a and b are equal from the local point of view, 1 if a must be sorted after b.

na_object_id_prepare_for_paste ()

void                na_object_id_prepare_for_paste      (NAObjectId *object,
                                                         gboolean relabel,
                                                         gboolean renumber,
                                                         NAObjectId *parent);

Prepares object to be pasted.

If a NAObjectProfile, then object is attached to the specified NAObjectAction action. The identifier is always renumbered to be suitable with the already existing profiles.

If a NAObjectAction or a NAObjectMenu, a new UUID is allocated if and only if relabel is TRUE.

Actual relabeling takes place if relabel is TRUE, depending of the user preferences.

object :

the NAObjectId object to be pasted.

relabel :

whether this object should be relabeled when pasted.

renumber :

whether this item should be renumbered ?

parent :

the parent of object, or NULL.

na_object_id_set_copy_of_label ()

void                na_object_id_set_copy_of_label      (NAObjectId *object);

Sets the 'Copy of' label.

object :

the NAObjectId object whose label is to be changed.

na_object_id_set_new_id ()

void                na_object_id_set_new_id             (NAObjectId *object,
                                                         const NAObjectId *new_parent);

Request a new id to the derived class, and set it.

object :

the NAObjectId object whose internal identifiant is to be set.

new_parent :

if object is a NAObjectProfile, then new_parent should be set to the NAObjectAction new parent. Else, it would not be possible to allocate a new profile id compatible with already existing ones.