notepad_utils.h

Go to the documentation of this file.

#ifndef __NOTEPAD_UTILS_H__
#define __NOTEPAD_UTILS_H__

/**
 * File Name  : notepad_utils.h
 *
 * Description: notepad utility classes
 */

/*
 * 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> // for gboolean
#include <liberscribble/scb.h> // for draw_line


namespace notepad 
{
    typedef enum
    {
        NP_PORTRAIT = 0,
        NP_CLOCKWISE,
        NP_ANTICLOCKWISE
    } np_rotation;

    typedef enum
    {
        NP_OK = 0,
        NP_IS_NOT_DIR,
        NP_FILE_EXISTS,
        NP_CREATE_FAILED,
        NP_OPEN_FAILED,
        NP_CLOSE_FAILED,
        NP_READ_FAILED,
        NP_RENAME_FAILED,
        NP_DELETE_FAILED,
        NP_NO_DOCUMENT,
        NP_NO_FILENAME,
        NP_SAVE_FAILED,
        NP_ALLOC_FAILED,
        NP_NO_PAGE,
        NP_ERROR
    } np_result;



    class GCtx
    {
        private:
            int         size;
            gint32      color;

        public:
            GdkGC*      gc;         ///< X11 graphics context.
            np_rotation rotation;   ///< rotation
            int         width;      ///< width, max y when in landscape, max x otherwise
            int         height;     ///< height, max x when in landscape, max y otherwise
            int         margin;     ///< border

            GCtx() 
                : size(0)
                , gc(0)
                , rotation(NP_PORTRAIT)
                , width(0)
                , height(0)
                , margin(0)
            {
            }

            ~GCtx() 
            {
                if (gc) { g_object_unref(gc); gc = 0; } 
            }

        private:
            GCtx(const GCtx& source);
            GCtx& operator=(const GCtx& source);



        public:
            void set_color(const ScbDevColor c);

            /// @brief Change the X11 gc to use new line attributes. 
            /// Currently, only change the width. Always use LineSolid.
            inline void set_line_attributes(const int width)
            {
                this->size = width ;

                gdk_gc_set_line_attributes(gc
                        , this->size
                        , GDK_LINE_SOLID
                        , GDK_CAP_PROJECTING
                        , GDK_JOIN_MITER);
            }

            /// @brief Draw line on image by using current line color, line width and 
            /// line style.
            void draw_line(GdkImage* image, const int x1, const int y1, const int x2, const int y2);

            inline void draw_line(GdkImage* image, const ScbPoint& p1, const ScbPoint& p2)
            {
                draw_line(image, p1.x, p1.y, p2.x, p2.y);
            }

            void draw_brush(GdkImage* image, const int x, const int y);
            void draw_points(GdkImage* image, const GdkPoint* shape, const int npoints_in_shape);
    };

    /// Point structure.
    struct Point
    {
        Point()
            : x(0), y(0)
        {}

        Point(const int ptx, const int pty)
            : x(ptx), y(pty)
        {}

        void reset(const int ptx, const int pty)
        {
            x = ptx; y = pty;
        }

        void move_x(const int ptx)
        {
            x = ptx;
        }

        void move_y(const int pty)
        {
            y = pty;
        }

        void move(const int x_offset, const int y_offset)
        {
            x += x_offset;
            y += y_offset;
        }

        int x, y;
    };

}

#endif // __NOTEPAD_UTILS_H__