RE/RE_Cursor.h

Go to the documentation of this file.

#ifndef __RE_Cursor__
#define __RE_Cursor__

#include "RE_API.h"
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <UT/UT_String.h>
#include "RE_Types.h"

#define RE_CURSOR_I_AM_BUSY             "busy"
#define RE_CURSOR_I_AM_INTERRUPTABLE    "interruptable"
#define RE_CURSOR_ARROW_RIGHT           "arrowRight"
#define RE_CURSOR_ARROW_UP              "arrowUp"
#define RE_CURSOR_ARROW_LEFT            "arrowLeft"
#define RE_CURSOR_ARROW_DOWN            "arrowDown"
#define RE_CURSOR_ARROW_ALL             "arrowAll"
#define RE_CURSOR_ARROW_ALL_D           "arrowAllDiagonal"
#define RE_CURSOR_ARROW_UP_DOWN         "arrowUpDown"
#define RE_CURSOR_ARROW_LEFT_RIGHT      "arrowLeftRight"
#define RE_CURSOR_ARROW_D1              "arrowD1"

#define RE_CURSOR_ARROW_D2              "arrowD2"
#define RE_CURSOR_ARROW_D3              "arrowD3"
#define RE_CURSOR_ARROW_D4              "arrowD4"
#define RE_CURSOR_ARROW_D1D3            "arrowD1D3"
#define RE_CURSOR_ARROW_D2D4            "arrowD2D4"
#define RE_CURSOR_CROSS                 "cross"
#define RE_CURSOR_CUT                   "cut"
#define RE_CURSOR_ARROW                 "arrow"
// WARNING: The following cursor (RE_CURSOR_IRIS) is hardcoded in
// BM_OpState.h
#define RE_CURSOR_IRIS                  "iris"
#define RE_CURSOR_X                     "X"

#define RE_CORNER_BL                    "cornerBL"
#define RE_CORNER_BR                    "cornerBR"
#define RE_CORNER_TL                    "cornerTL"
#define RE_CORNER_TR                    "cornerTR"

#define RE_CURSOR_DRAGDROP_ON           "dragdropOn"
#define RE_CURSOR_DRAGDROP_OFF          "dragdropOff"

#define RE_CURSOR_HAND                  "hand"
#define RE_CURSOR_HAND_POINT            "handpoint"
#define RE_CURSOR_QUESTION              "question"
#define RE_CURSOR_SELECT_IRIS           "select"

// This is not used anywhere and the 'smallBusy.cursor'
// file is corrupt.
//   #define RE_CURSOR_HOUR_GLASS       "smallBusy"

// Selection cursors
#define RE_CURSOR_SELECT_PREFIX         "select_"
#define RE_CURSOR_SELECT_WHITE_REPLACE  "select_white_replace"
#define RE_CURSOR_SELECT_WHITE_ADD      "select_white_add"
#define RE_CURSOR_SELECT_WHITE_REMOVE   "select_white_remove"
#define RE_CURSOR_SELECT_WHITE_TOGGLE   "select_white_toggle"
#define RE_CURSOR_SELECT_BLACK_REPLACE  "select_black_replace"
#define RE_CURSOR_SELECT_BLACK_ADD      "select_black_add"
#define RE_CURSOR_SELECT_BLACK_REMOVE   "select_black_remove"
#define RE_CURSOR_SELECT_BLACK_TOGGLE   "select_black_toggle"


class RE_API RE_Cursor
{
public:
    RE_Cursor();
    virtual ~RE_Cursor();

    virtual RE_IDType    getDeviceId(RE_IDType wid) = 0;
    virtual void         unload();

    const char *         getName() const    { return cursorName; }

protected:
    RE_Cursor(const char *name);

    static bool          getCursorInfo(const char *name,
                                       UT_String &path, int &x, int &y);

    short                readCursor(FILE *fp, const char *file);
    int                  loadBitmap(FILE *fp, int n, int l, const char *file);

    // TODO: Make these private and make them conform to convention
    const char          *cursorName;
    short                originX;
    short                originY;
    unsigned short      *bitmap;
    unsigned short      *mask;
};
#endif

---