src/core/na-iabout.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 __CORE_NA_IABOUT_H__
  32 #define __CORE_NA_IABOUT_H__
  33
  34 /* @title NAIAbout
  35  * @short_description: The #NAIAbout Interface Definition
  36  * @include: runtime/na-iabout.h
  37  *
  38  * This interface displays the 'About Nautilus-Actions' dialog box.
  39  * The application name may be provided by the implementor ; else,
  40  * the name of the application will be displayed.
  41  */
  42
  43 #include <gtk/gtk.h>
  44
  45 G_BEGIN_DECLS
  46
  47 #define NA_IABOUT_TYPE                      ( na_iabout_get_type())
  48 #define NA_IABOUT( object )                 ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_IABOUT_TYPE, NAIAbout ))
  49 #define NA_IS_IABOUT( object )              ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_IABOUT_TYPE ))
  50 #define NA_IABOUT_GET_INTERFACE( instance ) ( G_TYPE_INSTANCE_GET_INTERFACE(( instance ), NA_IABOUT_TYPE, NAIAboutInterface ))
  51
  52 typedef struct _NAIAbout                    NAIAbout;
  53 typedef struct _NAIAboutInterfacePrivate    NAIAboutInterfacePrivate;
  54
  55 typedef struct {
  56         /*< private >*/
  57         GTypeInterface            parent;
  58         NAIAboutInterfacePrivate *private;
  59
  60         /*< public >*/
  61         /**
  62          * get_application_name:
  63          * @iabout: this #NAIAbout implementor.
  64          *
  65          * Returns: the application name as a newly allocated string,
  66          * which will be g_free() by the interface.
  67          */
  68         gchar *     ( *get_application_name )( NAIAbout *instance );
  69
  70         /**
  71          * get_toplevel:
  72          * @iabout: this #NAIAbout implementor.
  73          *
  74          * Returns: the toplevel parent of the displayed dialog box.
  75          */
  76         GtkWindow * ( *get_toplevel )        ( NAIAbout *instance );
  77 }
  78         NAIAboutInterface;
  79
  80 GType  na_iabout_get_type( void );
  81
  82 void   na_iabout_display( NAIAbout *instance );
  83
  84 gchar *na_iabout_get_icon_name( void );
  85 gchar *na_iabout_get_copyright( gboolean console );
  86
  87 G_END_DECLS
  88
  89 #endif /* __CORE_NA_IABOUT_H__ */