erGtkPageBar.h

Go to the documentation of this file.

#ifndef __ERGTK_PAGE_BAR_H__
#define __ERGTK_PAGE_BAR_H__

/**
 * \file erGtkPageBar.h
 * \brief ereader gtk library - GtkPageBar widget 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 GTK_PAGEBAR_TYPE            (gtk_pagebar_get_type ())
#define GTK_PAGEBAR(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_PAGEBAR_TYPE, GtkPagebar))
#define GTK_PAGEBAR_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_PAGEBAR_TYPE, GtkPagebarClass))
#define IS_GTK_PAGEBAR(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_PAGEBAR_TYPE))
#define IS_GTK_PAGEBAR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_PAGEBAR_TYPE))

typedef struct _GtkPagebar GtkPagebar;
typedef struct _GtkPagebarClass GtkPagebarClass;

/**
 * @brief Creates a new gtk pagebar widget.
 *
 * @param - 
 *
 * @return Reference to created widget.
 */
GtkWidget *gtk_pagebar_new(void);

/**
 * @brief Specify the total number of page.
 * @param pagebar The pagebar object.
 * @param number The total page number.
 * @return It does not have return value.
 */
void gtk_pagebar_set_number_of_pages(GtkPagebar * pagebar,
                                     const unsigned int number);

/**
 * @brief Get total number from pagebar.
 * @param pagebar The pagebar object.
 * @return return the total number of pages
 */
unsigned int gtk_pagebar_get_number_of_pages(GtkPagebar * pagebar);

/**
 * @brief Specify the current page.
 * @param pagebar The pagebar object.
 * @param page The current page number.
 * @return It returns FALSE if current page is ouf of range. Otherwise
 * It returns TRUE.
 */
gboolean gtk_pagebar_set_current_page(GtkPagebar * pagebar,
                                      const unsigned int page);

/**
 * @brief Get the current page.
 * @param pagebar The pagebar object.
 * @return Return the number of current page
 */
unsigned int gtk_pagebar_get_current_page(GtkPagebar * pagebar);

/**
 * @brief Add a bookmark to the specified page.
 * @param pagebar The pagebar object.
 * @param page The target page number.
 * @return It returns FALSE if set fails, otherwise
 * returns TRUE.
 */
gboolean gtk_pagebar_set_bookmark(GtkPagebar * pagebar,
                                  const unsigned int page);

/**
 * @brief Remove a bookmark of specified page
 * @param pagebar The pagebar object.
 * @param page The target page number.
 * @return Returns TRUE if sucessfully delete the bookmark, otherwise
 * returns FALSE
 */
gboolean gtk_pagebar_delete_bookmark(GtkPagebar * pagebar,
                                     const unsigned int page);

/**
 * @brief Get the read only bookmarks array
 * @param pagebar The pagebar object.
 * @return Returns the READ ONLY bookmarks array. It can be NULL
 */
const GArray* gtk_pagebar_get_bookmarks(GtkPagebar * pagebar);

/**
 * @brief Reset the pagebar.
 * @param pagebar The pagebar object.
 * @return This function does not have return value.
 */
void gtk_pagebar_reset(GtkPagebar * pagebar);

/**
 * @brief Get type of gtk pagebar widget.
 *
 * @returns type
 */
GType gtk_pagebar_get_type(void);

/**
 * @brief Get the minimal height of pagebar. If the widget height is less
   than minimal height, the pagebar cannot be displayed normally.
 * @param pagebar The pagebar object.
 * @return return the minimal height of page bar.
 */
unsigned int gtk_pagebar_get_minimal_height(GtkPagebar * pagebar);

/**
 * @brief Redraw the pagebar.
 * @param pagebar The pagebar object.
 */
void gtk_pagebar_update(GtkPagebar * pagebar);

G_END_DECLS

#endif              // __GTK_PAGE_BAR_H__