na-object-id.h 4.01 KB
Newer Older
1
/*
2
 * Nautilus-Actions
3 4 5 6
 * A Nautilus extension which offers configurable context menu actions.
 *
 * Copyright (C) 2005 The GNOME Foundation
 * Copyright (C) 2006, 2007, 2008 Frederic Ruaudel and others (see AUTHORS)
Pierre Wieser's avatar
Pierre Wieser committed
7
 * Copyright (C) 2009, 2010, 2011 Pierre Wieser and others (see AUTHORS)
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
 *
 * This Program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This Program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this Library; see the file COPYING.  If not,
 * write to the Free Software Foundation, Inc., 59 Temple Place,
 * Suite 330, Boston, MA 02111-1307, USA.
 *
 * Authors:
 *   Frederic Ruaudel <grumz@grumz.net>
 *   Rodrigo Moya <rodrigo@gnome-db.org>
 *   Pierre Wieser <pwieser@trychlos.org>
 *   ... and many others (see AUTHORS)
 */

31 32
#ifndef __NAUTILUS_ACTIONS_API_NA_OBJECT_ID_H__
#define __NAUTILUS_ACTIONS_API_NA_OBJECT_ID_H__
33

34
/**
35
 * SECTION: object-id
36
 * @title: NAObjectId
37
 * @short_description: The Identified Object Base Class Definition
38
 * @include: nautilus-actions/na-object-id.h
39
 *
40
 * This is a pure virtual class, i.e. not an instantiatable one.
41
 * It serves as the base class for #NAObject -derived object which have
42
 * a unique Id, i.e. for #NAObjectItem and #NAObjectProfile.
43 44
 */

45
#include "na-object.h"
46 47 48

G_BEGIN_DECLS

49 50 51 52 53 54
#define NA_OBJECT_ID_TYPE                  ( na_object_id_get_type())
#define NA_OBJECT_ID( object )             ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_OBJECT_ID_TYPE, NAObjectId ))
#define NA_OBJECT_ID_CLASS( klass )        ( G_TYPE_CHECK_CLASS_CAST( klass, NA_OBJECT_ID_TYPE, NAObjectIdClass ))
#define NA_IS_OBJECT_ID( object )          ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_OBJECT_ID_TYPE ))
#define NA_IS_OBJECT_ID_CLASS( klass )     ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_OBJECT_ID_TYPE ))
#define NA_OBJECT_ID_GET_CLASS( object )   ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_OBJECT_ID_TYPE, NAObjectIdClass ))
55

56
typedef struct _NAObjectIdPrivate      NAObjectIdPrivate;
57 58

typedef struct {
59
	/*< private >*/
60 61
	NAObject           parent;
	NAObjectIdPrivate *private;
62
}
63
	NAObjectId;
64

65
typedef struct _NAObjectIdClassPrivate NAObjectIdClassPrivate;
66

67 68 69 70 71 72
/**
 * NAObjectIdClass:
 * @new_id: Allocate a new id to an existing NAObjectId.
 *
 * The #NAObjectIdClass defines some methods available to derived classes.
 */
73
typedef struct {
74
	/*< private >*/
75 76
	NAObjectClass           parent;
	NAObjectIdClassPrivate *private;
77

78
	/*< public >*/
79 80
	/**
	 * new_id:
81 82 83
	 * @object: a NAObjectId object.
	 * @new_parent: possibly the new NAObjectId parent, or NULL.
	 * If not NULL, this should actually be a NAObjectItem.
84
	 *
85 86
	 * If @object is a NAObjectProfile, then @new_parent must be a
	 * not null NAObjectAction. This function ensures that the new
87 88 89 90 91
	 * profile name does not already exist in the given @new_parent.
	 *
	 * This is a pure virtual function which should be implemented by
	 * the actual class. Actually, we asks for the most-derived class
	 * which implements this function.
92 93 94
	 *
	 * Returns: a new id suitable for this @object.
	 *
95
	 * Since: 2.30
96 97
	 */
	gchar * ( *new_id )( const NAObjectId *object, const NAObjectId *new_parent );
98
}
99
	NAObjectIdClass;
100

101
GType  na_object_id_get_type( void );
102

103 104 105
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 );

106
void   na_object_id_prepare_for_paste( NAObjectId *object, gboolean relabel, gboolean renumber, NAObjectId *parent );
107 108 109
void   na_object_id_set_copy_of_label( NAObjectId *object );
void   na_object_id_set_new_id       ( NAObjectId *object, const NAObjectId *new_parent );

110 111
G_END_DECLS

112
#endif /* __NAUTILUS_ACTIONS_API_NA_OBJECT_ID_H__ */