src/ui/fma-status-bar.h

   1 /*
   2  * FileManager-Actions
   3  * A file-manager extension which offers configurable context statusbar actions.
   4  *
   5  * Copyright (C) 2005 The GNOME Foundation
   6  * Copyright (C) 2006-2008 Frederic Ruaudel and others (see AUTHORS)
   7  * Copyright (C) 2009-2015 Pierre Wieser and others (see AUTHORS)
   8  *
   9  * FileManager-Actions 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  * FileManager-Actions 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 GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with FileManager-Actions; see the file COPYING. If not, see
  21  * <http://www.gnu.org/licenses/>.
  22  *
  23  * Authors:
  24  *   Frederic Ruaudel <grumz@grumz.net>
  25  *   Rodrigo Moya <rodrigo@gnome-db.org>
  26  *   Pierre Wieser <pwieser@trychlos.org>
  27  *   ... and many others (see AUTHORS)
  28  */
  29
  30 #ifndef __UI_FMA_STATUS_BAR_H__
  31 #define __UI_FMA_STATUS_BAR_H__
  32
  33 /**
  34  * SECTION: fma_status_bar
  35  * @short_description: Statusbar class definition.
  36  * @include: ui/fma-status-bar.h
  37  *
  38  * The #FMAStatusBar embeds both:
  39  * - a message bar
  40  * - a read-only indicator.
  41  */
  42
  43 #include "fma-main-window-def.h"
  44
  45 G_BEGIN_DECLS
  46
  47 #define FMA_TYPE_STATUS_BAR                ( fma_status_bar_get_type())
  48 #define FMA_STATUS_BAR( object )           ( G_TYPE_CHECK_INSTANCE_CAST( object, FMA_TYPE_STATUS_BAR, FMAStatusBar ))
  49 #define FMA_STATUS_BAR_CLASS( klass )      ( G_TYPE_CHECK_CLASS_CAST( klass, FMA_TYPE_STATUS_BAR, FMAStatusBarClass ))
  50 #define FMA_IS_STATUS_BAR( object )        ( G_TYPE_CHECK_INSTANCE_TYPE( object, FMA_TYPE_STATUS_BAR ))
  51 #define FMA_IS_STATUS_BAR_CLASS( klass )   ( G_TYPE_CHECK_CLASS_TYPE(( klass ), FMA_TYPE_STATUS_BAR ))
  52 #define FMA_STATUS_BAR_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), FMA_TYPE_STATUS_BAR, FMAStatusBarClass ))
  53
  54 typedef struct _FMAStatusBarPrivate        FMAStatusBarPrivate;
  55
  56 typedef struct {
  57         /*< private >*/
  58         GtkStatusbar         parent;
  59         FMAStatusBarPrivate *private;
  60 }
  61         FMAStatusBar;
  62
  63 typedef struct {
  64         /*< private >*/
  65         GtkStatusbarClass    parent;
  66 }
  67         FMAStatusBarClass;
  68
  69 GType         fma_status_bar_get_type            ( void );
  70
  71 FMAStatusBar *fma_status_bar_new                 ( void );
  72
  73 void          fma_status_bar_display_status      ( FMAStatusBar *bar,
  74                                                                                                                 const gchar *context,
  75                                                                                                                 const gchar *status );
  76
  77 void          fma_status_bar_display_with_timeout( FMAStatusBar *bar,
  78                                                                                                                 const gchar *context,
  79                                                                                                                 const gchar *status );
  80
  81 void          fma_status_bar_hide_status         ( FMAStatusBar *bar,
  82                                                                                                                 const gchar *context );
  83
  84 void          fma_status_bar_set_locked          ( FMAStatusBar *bar,
  85                                                                                                                 gboolean readonly,
  86                                                                                                                 gint reason );
  87
  88 G_END_DECLS
  89
  90 #endif /* __UI_FMA_STATUS_BAR_H__ */