notepad_point.h

Go to the documentation of this file.

#ifndef __NOTEPAD_POINT_H__
#define __NOTEPAD_POINT_H__

/**
 * File Name  : notepad_point.h
 *
 * Description: notepad point 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 <liberscribble/scb.h>
#include "notepad_utils.h"


namespace notepad 
{
    class CNPoint
    {
        public:
            // object lifecycle
            ~CNPoint();
            CNPoint(const CNPoint&);            
            CNPoint& operator=(const CNPoint&); 

        public:
            // methods
            // constructors
            CNPoint(int an_X, int a_Y); // X and Y are window coordinates (windowView)
            CNPoint(const ScbPoint& p);              // p is ScbPoint and is a storageView coordinate
            // View points
            ScbPoint deviceView(); // this is the deltaview: x and y are always in portrait and absolute screen coordinates
            ScbPoint windowView(); // this is the windowView: x and y are dependent of orientation and borders and as such relative to the window coordinates
            ScbPoint storageView();// this is the storageview: x and y are absolute and always in portrait and absolute screen coordinates
        public:
            // static functions
            static void setRotation(np_rotation aRotation);
            static void setClipBorder(int border);
            static void setBorders(int left, int right, int top, int bottom);
            static void setScreen(int w, int h);
        private:
            CNPoint();
            void clipToMaxBorder();

        private:
            // members
            // x and y are the absolute coordinates on the screen (not the gtk window)
            // which is the device view
            int x;
            int y;

        private:
            // class invariant: rotation is the current orientation of the DR 
            static np_rotation rotation;
            // class invariant: for all x,y: leftborder < x < rightborder && topborder < y < bottomborder
            static int left_border;
            static int right_border;
            static int top_border;
            static int bottom_border;
            static int max_border;
            static int screen_height;
            static int screen_width;
    };

}

#endif // __NOTEPAD_POINT_H__