scbpages.h

Go to the documentation of this file.

#ifndef SCBPAGES_H_
#define SCBPAGES_H_

/*
 * File Name  : scbpages.h
 * 
 * Description: Scribble library macros
 */

/*
 * This file is part of liberscribble.
 *
 * liberscribble 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.
 *
 * liberscribble 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.
 */
 

//----------------------------------------------------------------------------
// Include Files
//----------------------------------------------------------------------------

// system include files, between < >
#include <glib.h>

// ereader include files, between < >

// local include files, between " "
#include "scbpage.h"

G_BEGIN_DECLS


//----------------------------------------------------------------------------
// Definitions
//---------------------------------------------------------------------------- 


//----------------------------------------------------------------------------
// Forward Declarations
//----------------------------------------------------------------------------


//----------------------------------------------------------------------------
// Type Declarations
//----------------------------------------------------------------------------

typedef struct _ScbPages
{
    GList * pages;       /**< A list of scribble pages pointers */
} ScbPages;

typedef ScbPages * ScbPagesPtr;


//----------------------------------------------------------------------------
// Global Constants
//----------------------------------------------------------------------------


//============================================================================
// Public Functions
//============================================================================

// Construct a new pages list, the member pages in ScbPages structure
// will be initialized
// @param ptr the pointer of a ScbPages instance
// @return return TRUE if construction succeeds
gboolean erscribble_pages_new(ScbPagesPtr ptr);

// Free the list as well as all of the items
// @param ptr the pointer of a ScbPages instance
void erscribble_pages_free(ScbPagesPtr ptr);

// Add a page instance into the list
// If the same page has been cached, return directly
// @param pages the pointer of pages list
// @param page the scribble page to be added
// @return return TRUE if page exists in the list
gboolean erscribble_pages_add_page(ScbPagesPtr pages, ScbPagePtr page);

// Detach a ScbPage instance from list without freeing the page
// @param pages the pointer of pages list
// @param id ID of the scribble page which needs to be detached
// @return return the detached page instance
ScbPagePtr erscribble_pages_detach_page(ScbPagesPtr pages, ScbPageIdPtr id);

// Remove a ScbPage instance from list and free the page
// @param pages the pointer of pages list
// @param id ID of the scribble page which needs to be freed
void erscribble_pages_remove_page(ScbPagesPtr pages, ScbPageIdPtr id);

// Get the number of pages in a list
// @param ptr the pointer of pages list
// @return return the number of pages
int erscribble_pages_get_count(ScbPagesPtr ptr);

// Get a scribble page by ID
// @param pages the pointer of pages list
// @param id ID of the scribble page for searching
// @return return the needed page if it exists, otherwise return NULL
ScbPagePtr erscribble_pages_get_page(ScbPagesPtr pages, ScbPageIdPtr id);

// Change the ID of a page that is in the page list
// @param pages the pointer of pages list
// @param oldId the original id of the page instance
// @param newId the new id of the page instance
// @return return TRUE if the id sucessfully changes, otherwise return FALSE
gboolean erscribble_pages_change_page_id(ScbPagesPtr pages, ScbPageIdPtr oldId, 
                                         ScbPageIdPtr newId);

// Dump the data of pages
// This function can be used for debug
void erscribble_pages_dump(ScbPagesPtr pages);

gboolean remove_oldest_page_data(ScbPagesPtr pages);

G_END_DECLS

#endif