cursors.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.TXT for contributors.
 *
 * This program 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.
 *
 * This program 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 <https://www.gnu.org/licenses/>.
 */
 
#ifndef CURSOR_STORE__H
#define CURSOR_STORE__H
 
#include <gal/gal.h>
#include <wx/cursor.h>
 
#include <map>
#include <vector>

#if wxCHECK_VERSION( 3, 3, 0 )
typedef wxCursorBundle WX_CURSOR_TYPE;
#else
typedef wxCursor WX_CURSOR_TYPE;
#endif
 
 
enum class KICURSOR
{
    DEFAULT,
    ARROW,
    ARROW64,
    MOVING,
    MOVING64,
    WARNING,
    WARNING64,
    PENCIL,
    PENCIL64,
    REMOVE,
    REMOVE64,
    HAND,
    HAND64,
    BULLSEYE,
    BULLSEYE64,
    VOLTAGE_PROBE,
    VOLTAGE_PROBE64,
    CURRENT_PROBE,
    CURRENT_PROBE64,
    TUNE,
    TUNE64,
    TEXT,
    TEXT64,
    MEASURE,
    MEASURE64,
    ADD,
    ADD64,
    SUBTRACT,
    SUBTRACT64,
    XOR,
    XOR64,
    ZOOM_IN,
    ZOOM_IN64,
    ZOOM_OUT,
    ZOOM_OUT64,
    LABEL_NET,
    LABEL_NET64,
    LABEL_GLOBAL,
    LABEL_GLOBAL64,
    COMPONENT,
    COMPONENT64,
    SELECT_WINDOW,
    SELECT_WINDOW64,
    SELECT_LASSO,
    SELECT_LASSO64,
    LINE_BUS,
    LINE_BUS64,
    LINE_GRAPHIC,
    LINE_GRAPHIC64,
    LINE_WIRE,
    LINE_WIRE64,
    LABEL_HIER,
    LABEL_HIER64,
    PLACE,
    PLACE64
};

class GAL_API CURSOR_STORE
{
public:
    struct CURSOR_DEF
    {
        const char** m_xpm;

        wxPoint m_hotspot;
    };

    static const WX_CURSOR_TYPE GetCursor( KICURSOR aCursorType, bool aHiDPI = false );

    static wxStockCursor GetStockCursor( KICURSOR aCursorType );
 
private:
    CURSOR_STORE();
 
#if wxCHECK_VERSION( 3, 3, 0 )
    const wxCursorBundle& storeGetBundle( KICURSOR aIdKey ) const;
#else
    const wxCursor& storeGetCursor( KICURSOR aIdKey, bool aHiDPI = false ) const;
#endif
 
#if wxCHECK_VERSION( 3, 3, 0 )
    std::map<KICURSOR, wxCursorBundle> m_bundleMap;
#else
    std::map<KICURSOR, wxCursor> m_standardCursorMap;
    std::map<KICURSOR, wxCursor> m_hidpiCursorMap;
#endif
 
};
 
#endif // CURSOR_STORE__H