notepad_doc.h

Go to the documentation of this file.

#ifndef __NOTEPAD_DOC_H__
#define __NOTEPAD_DOC_H__

/**
 * File Name  : notepad_doc.h
 *
 * Description: notepad document class
 */

/*
 * This file is part of notepad.
 *
 * notepad 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.
 *
 * notepad 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) 2010 IREX Technologies B.V.
 * All rights reserved.
 */
 
#include <glib.h>
#include <gtk/gtk.h> 

#include "notepad_utils.h"
#include "notepad_point.h"
#include "notepad_filestore.h"
#include <liberscribble/scb.h>

namespace notepad 
{

    class CNotepadDoc
    {
        public:
            // object lifecycle
            CNotepadDoc();
            ~CNotepadDoc();

        private:
            CNotepadDoc(const CNotepadDoc&);            // no copy 
            CNotepadDoc& operator=(const CNotepadDoc&); // no assignment

        public:
            // document lifecycle
            np_result open(const gchar* filename);      // document filename is absolute
            np_result create(const gchar* filename);    // create empty document
            np_result save_page(const int pageno, bool update_last_read = false); // saves latest changes of current page
            np_result rename(const gchar* filename);    // saves current document using other name
            void      close();
            int       get_num_pages();                  // Retrieves the number of pages
            gchar*    get_full_filename();              // Retrieves the filename with path and extension
            gchar*    get_filename_without_dir_and_ext(); // Retrieves the short filename without path and extension
            CFileStore* getFileStore();                 // Retrieve the filestore class
            gboolean  get_page_dirty();                 // Retrieve the dirty flag

        private:
            void generate_page_id(ScbPageId& pageId, const int pageno);

            // page functions
        public:
            void insert_page(const int pageno);
            void add_page(const int pageno);
            void delete_page(const int pageno);
            void clear_page(const int pageno);
            gboolean set_last_read(gint value);
            gint     get_last_read(void);

        public:
            // drawing functions

            void on_scribble_begin(
                    const int           pageno,
                    GCtx&               gctx,
                    GdkImage*           image,
                    CNPoint&            apoint);

            void on_scribble_move(
                    const int           pageno,
                    GCtx&               gctx,
                    GdkImage*           image,
                    CNPoint&            apoint);

            void on_scribble_end(
                    const int           pageno,
                    GCtx&               gctx,
                    GdkImage*           image,
                    CNPoint&            apoint);

            void on_erase_begin(
                    const int           pageno,
                    GCtx&               gctx,
                    GdkImage*           image,
                    CNPoint&            apoint);

            void on_erase_move(
                    const int           pageno,
                    GCtx&               gctx,
                    GdkImage*           image,
                    CNPoint&            apoint);

            void on_erase_end(
                    const int           pageno,
                    GCtx&               gctx,
                    GdkImage*           image,
                    CNPoint&            apoint);

            void draw_scribble_page(const int pageno, GCtx& gctx, GdkImage* image); 

        private:
            void draw_stroke(GCtx& gctx, GdkImage*  image, ScbStrokePtr stroke);
            void draw_erased_strokes(GCtx& gctx, GdkImage* image, ScbStrokesPtr strokes);

        private:
            ScbPath         path;                       //< The scribble document path.
            ScbDocPtr       doc;                        //< The scribble document.
            ScbPagePtr      page;                       //< Page currently used.
            ScbStrokePtr    stroke;                     //< Stroke currently used.
            ScbPageEraseCtx erase_context;              //< Used by erscribble library.

            gboolean        dirty;                      //< Used to decide if to save or not

            CFileStore*     file_store;                 //< Storage
    };

}

#endif // __NOTEPAD_DOC_H__