src/api/na-object-id.h

   1 /*
   2  * Nautilus-Actions
   3  * A Nautilus extension which offers configurable context menu actions.
   4  *
   5  * Copyright (C) 2005 The GNOME Foundation
   6  * Copyright (C) 2006, 2007, 2008 Frederic Ruaudel and others (see AUTHORS)
   7  * Copyright (C) 2009, 2010, 2011 Pierre Wieser and others (see AUTHORS)
   8  *
   9  * This Program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License as
  11  * published by the Free Software Foundation; either version 2 of
  12  * the License, or (at your option) any later version.
  13  *
  14  * This Program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public
  20  * License along with this Library; see the file COPYING.  If not,
  21  * write to the Free Software Foundation, Inc., 59 Temple Place,
  22  * Suite 330, Boston, MA 02111-1307, USA.
  23  *
  24  * Authors:
  25  *   Frederic Ruaudel <grumz@grumz.net>
  26  *   Rodrigo Moya <rodrigo@gnome-db.org>
  27  *   Pierre Wieser <pwieser@trychlos.org>
  28  *   ... and many others (see AUTHORS)
  29  */
  30
  31 #ifndef __NAUTILUS_ACTIONS_API_NA_OBJECT_ID_H__
  32 #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 G_BEGIN_DECLS
  48
  49 #define NA_OBJECT_ID_TYPE                ( na_object_id_get_type())
  50 #define NA_OBJECT_ID( object )           ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_OBJECT_ID_TYPE, NAObjectId ))
  51 #define NA_OBJECT_ID_CLASS( klass )      ( G_TYPE_CHECK_CLASS_CAST( klass, NA_OBJECT_ID_TYPE, NAObjectIdClass ))
  52 #define NA_IS_OBJECT_ID( object )        ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_OBJECT_ID_TYPE ))
  53 #define NA_IS_OBJECT_ID_CLASS( klass )   ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_OBJECT_ID_TYPE ))
  54 #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         NAObject           parent;
  61         NAObjectIdPrivate *private;
  62 }
  63         NAObjectId;
  64
  65 typedef struct _NAObjectIdClassPrivate   NAObjectIdClassPrivate;
  66
  67 /**
  68  * NAObjectIdClass:
  69  * @new_id: Allocate a new id to an existing NAObjectId.
  70  *
  71  * The #NAObjectIdClass defines some methods available to derived classes.
  72  */
  73 typedef struct {
  74         /*< private >*/
  75         NAObjectClass           parent;
  76         NAObjectIdClassPrivate *private;
  77
  78         /*< public >*/
  79         /**
  80          * new_id:
  81          * @object: a NAObjectId object.
  82          * @new_parent: possibly the new NAObjectId parent, or NULL.
  83          * If not NULL, this should actually be a NAObjectItem.
  84          *
  85          * If @object is a NAObjectProfile, then @new_parent must be a
  86          * not null NAObjectAction. This function ensures that the new
  87          * profile name does not already exist in the given @new_parent.
  88          *
  89          * This is a pure virtual function which should be implemented by
  90          * the actual class. Actually, we asks for the most-derived class
  91          * which implements this function.
  92          *
  93          * Returns: a new id suitable for this @object.
  94          *
  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 gint   na_object_id_sort_alpha_asc   ( const NAObjectId *a, const NAObjectId *b );
 104 gint   na_object_id_sort_alpha_desc  ( const NAObjectId *a, const NAObjectId *b );
 105
 106 void   na_object_id_prepare_for_paste( NAObjectId *object, gboolean relabel, gboolean renumber, NAObjectId *parent );
 107 void   na_object_id_set_copy_of_label( NAObjectId *object );
 108 void   na_object_id_set_new_id       ( NAObjectId *object, const NAObjectId *new_parent );
 109
 110 G_END_DECLS
 111
 112 #endif /* __NAUTILUS_ACTIONS_API_NA_OBJECT_ID_H__ */