src/ui/fma-sort-buttons.h

   1 /*
   2  * FileManager-Actions
   3  * A file-manager extension which offers configurable context menu 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_SORT_BUTTONS_H__
  31 #define __UI_FMA_SORT_BUTTONS_H__
  32
  33 /**
  34  * SECTION: fma-sort-buttons
  35  * @title: FMASortButtons
  36  * @short_description: The Sort Buttons class definition
  37  * @include: ui/fma-sort-buttons.h
  38  *
  39  * A convenience class to manager sort buttons in the user interface.
  40  *
  41  * The sort order mode is monitored, so that buttons automatically display
  42  * the right order mode if it is modified by another way (e.g. from
  43  * Preferences editor).
  44  *
  45  * Modifying the sort order mode requires that:
  46  * - level zero is writable (see FMAUpdater)
  47  * - preferences are not locked (see FMAUpdater)
  48  * - sort order mode is not a mandatory preference.
  49  */
  50
  51 #include "fma-main-window-def.h"
  52
  53 G_BEGIN_DECLS
  54
  55 #define FMA_TYPE_SORT_BUTTONS                ( fma_sort_buttons_get_type())
  56 #define FMA_SORT_BUTTONS( object )           ( G_TYPE_CHECK_INSTANCE_CAST( object, FMA_TYPE_SORT_BUTTONS, FMASortButtons ))
  57 #define FMA_SORT_BUTTONS_CLASS( klass )      ( G_TYPE_CHECK_CLASS_CAST( klass, FMA_TYPE_SORT_BUTTONS, FMASortButtonsClass ))
  58 #define FMA_IS_SORT_BUTTONS( object )        ( G_TYPE_CHECK_INSTANCE_TYPE( object, FMA_TYPE_SORT_BUTTONS ))
  59 #define FMA_IS_SORT_BUTTONS_CLASS( klass )   ( G_TYPE_CHECK_CLASS_TYPE(( klass ), FMA_TYPE_SORT_BUTTONS ))
  60 #define FMA_SORT_BUTTONS_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), FMA_TYPE_SORT_BUTTONS, FMASortButtonsClass ))
  61
  62 typedef struct _FMASortButtonsPrivate        FMASortButtonsPrivate;
  63
  64 typedef struct {
  65         /*< private >*/
  66         GObject                parent;
  67         FMASortButtonsPrivate *private;
  68 }
  69         FMASortButtons;
  70
  71 typedef struct {
  72         /*< private >*/
  73         GObjectClass           parent;
  74 }
  75         FMASortButtonsClass;
  76
  77 GType           fma_sort_buttons_get_type( void );
  78
  79 FMASortButtons *fma_sort_buttons_new     ( FMAMainWindow *window );
  80
  81 G_END_DECLS
  82
  83 #endif /* __UI_FMA_SORT_BUTTONS_H__ */