ergtklistview.h

Go to the documentation of this file.

#ifndef __ERGTK_LIST_VIEW_H__
#define __ERGTK_LIST_VIEW_H__

/**
 * \file ergtklistview.h
 * \brief ereader gtk library - GtkTreeView object adapted for ereader system
 */
 
/*
 * This file is part of libergtk.
 *
 * libergtk 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.
 *
 * libergtk 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 program. If not, see <http://www.gnu.org/licenses/>.
 */
 
/**
 * Copyright (C) 2008 iRex Technologies B.V.
 * All rights reserved.
 */
 
G_BEGIN_DECLS

#ifdef ENABLE_NLS
#define P_(String) dgettext(GETTEXT_PACKAGE "-properties",String)
#else 
#define P_(String) (String)
#endif

/* not really I18N-related, but also a string marker macro */
#define I_(string) g_intern_static_string (string)


#define ERGTK_TYPE_LIST_VIEW                (ergtk_list_view_get_type())
#define ERGTK_LIST_VIEW(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), ERGTK_TYPE_LIST_VIEW, erGtkListView))
#define ERGTK_IS_LIST_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), ERGTK_TYPE_LIST_VIEW))

#define ERGTK_LIST_VIEW_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass),  ERGTK_TYPE_LIST_VIEW, erGtkListViewClass))
#define ERGTK_LIST_VIEW_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj),  ERGTK_TYPE_LIST_VIEW, erGtkListViewClass))
#define ERGTK_IS_LIST_VIEW_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE((klass),  ERGTK_TYPE_LIST_VIEW))

typedef enum
{
    ERGTK_LIST_VIEW_PRESS_SHORT_UP,
    ERGTK_LIST_VIEW_PRESS_SHORT_DOWN,
    ERGTK_LIST_VIEW_PRESS_LONG_UP,
    ERGTK_LIST_VIEW_PRESS_LONG_DOWN,
    ERGTK_LIST_VIEW_PRESS_ACTIVATE
} erGtkListViewKeyPress;

typedef struct _erGtkListView      erGtkListView;
typedef struct _erGtkListViewClass erGtkListViewClass;

struct _erGtkListView
{
    GtkTreeView         parent;         // parent class
    
    // private
    //   fixed height for each row
    gint                row_height;
    gboolean            is_forced_height;
    //   button-press info
    gboolean            is_button_down;
    guint               press_event_button;
    gint                press_event_state;
    gint                press_event_x;
    gint                press_event_y;
    gint                press_item_idx;
};

struct _erGtkListViewClass
{
    GtkTreeViewClass parent_class;

    // virtual methods

    // signal handlers
    gboolean (*pre_move_cursor) ( erGtkListView         *list_view,
                                  erGtkListViewKeyPress navigate   );
};


// public functions
GtkWidget       *ergtk_list_view_new                    ( void );

GtkWidget       *ergtk_list_view_new_with_model         ( GtkTreeModel          *model );

gint            ergtk_list_view_append_column           ( erGtkListView         *er_listview,
                                                          GtkTreeViewColumn     *column      );

void            ergtk_list_view_get_view_size           ( erGtkListView         *er_listview, 
                                                          gint                  *num_rows, 
                                                          gint                  *num_items   );

void            ergtk_list_view_get_cursor              ( erGtkListView         *er_listview, 
                                                                                 gint *row   );

void            ergtk_list_view_set_cursor              ( erGtkListView         *er_listview, 
                                                          gint                  row          ); 

void            ergtk_list_view_set_focus_mode          ( erGtkListView         *er_listview, 
                                                          gboolean              focus_in,
                                                          gboolean              focus_out    );

void            ergtk_list_view_set_row_height          ( erGtkListView         *er_listview,
                                                          gint                  row_height   );


/**
 * get type of erGtkListView widget
 *
 * @returns type
 */
GType ergtk_list_view_get_type(void);


G_END_DECLS

#endif  // __ERGTK_LIST_VIEW_H__