erGtkIconView.h

Go to the documentation of this file.

#ifndef __ERGTK_ICON_VIEW_H__
#define __ERGTK_ICON_VIEW_H__

/**
 * \file erGtkIconView.h
 * \brief ereader gtk library - GtkIconView 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

#define ERGTK_TYPE_ICON_VIEW                (ergtk_icon_view_get_type())
#define ERGTK_ICON_VIEW(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), ERGTK_TYPE_ICON_VIEW, erGtkIconView))
#define ERGTK_IS_ICON_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), ERGTK_TYPE_ICON_VIEW))

#define ERGTK_ICON_VIEW_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass),  ERGTK_TYPE_ICON_VIEW, erGtkIconViewClass))
#define ERGTK_ICON_VIEW_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj),  ERGTK_TYPE_ICON_VIEW, erGtkIconViewClass))
#define ERGTK_IS_ICON_VIEW_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE((klass),  ERGTK_TYPE_ICON_VIEW))

#define ERGTK_ICON_VIEW_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), ERGTK_TYPE_ICON_VIEW, erGtkIconViewPrivate))

typedef enum
{
    ERGTK_ICON_VIEW_PRESS_SHORT_UP,
    ERGTK_ICON_VIEW_PRESS_SHORT_DOWN,
    ERGTK_ICON_VIEW_PRESS_SHORT_LEFT,
    ERGTK_ICON_VIEW_PRESS_SHORT_RIGHT,
    ERGTK_ICON_VIEW_PRESS_LONG_UP,
    ERGTK_ICON_VIEW_PRESS_LONG_DOWN,
    ERGTK_ICON_VIEW_PRESS_LONG_LEFT,
    ERGTK_ICON_VIEW_PRESS_LONG_RIGHT,
    ERGTK_ICON_VIEW_PRESS_ACTIVATE
} erGtkIconViewKeyPress;

typedef struct _erGtkIconView      erGtkIconView;
typedef struct _erGtkIconViewClass erGtkIconViewClass;

/**===========================================================================
 *
 * Class Name: erGtkIconView
 *
 * @brief:     Derive from GtkIconView.
 *             Properties:
 *             navigate-mode       gchar *       READ/WRITE
 *             "normal-navigate-mode" default navigate mode. 
 *             "simple-navigate-mode" translate up/down to left/right.
 *
 *==========================================================================*/

struct _erGtkIconView
{
    GtkIconView            parent;                // parent class
    
    // private
    struct _erGtkIconView  *next;
    struct _erGtkIconView  *previous;
    
    gint num_rows;
    gint num_cols;
};

struct _erGtkIconViewClass
{
    GtkIconViewClass parent_class;

    // virtual methods

    // signal handlers
    gboolean (*pre_move_cursor) ( erGtkIconView         *icon_view,
                                  erGtkIconViewKeyPress navigate   );
};

GtkWidget          *ergtk_icon_view_new                     (void);
GtkWidget          *ergtk_icon_view_new_with_model          (GtkTreeModel           *model);

void                ergtk_icon_view_set_model               (erGtkIconView          *er_iconview,
                                                             GtkTreeModel           *model);

void                ergtk_icon_view_set_next                (erGtkIconView          *er_iconview,
                                                             erGtkIconView          *next);

void                ergtk_icon_view_set_previous            (erGtkIconView          *er_iconview,
                                                             erGtkIconView          *previous);

void                ergtk_icon_view_get_view_size           (erGtkIconView          *er_iconview,
                                                             gint                   *num_rows,
                                                             gint                   *num_cols,
                                                             gint                   *num_items);

void                ergtk_icon_view_get_icon_size           (erGtkIconView          *er_iconview,
                                                             gint                   *icon_width,
                                                             gint                   *icon_height);

void                ergtk_icon_view_get_cursor              (erGtkIconView          *er_iconview,
                                                             gint                   *row,
                                                             gint                   *col);

void                ergtk_icon_view_set_cursor              (erGtkIconView          *er_iconview,
                                                             gint                   row,
                                                             gint                   col);

void                ergtk_icon_view_set_focus_mode          (erGtkIconView          *er_listview, 
                                                             gboolean               focus_in,
                                                             gboolean               focus_out);


/**
 * get type of erGtkIconView widget
 *
 * @returns type
 */
GType ergtk_icon_view_get_type(void);


G_END_DECLS

#endif  // __ERGTK_ICON_VIEW_H__