KiCad PCB EDA Suite
cursors.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2019-2021 KiCad Developers, see AUTHORS.TXT for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#ifndef CURSOR_STORE__H
25#define CURSOR_STORE__H
26
27#include <wx/cursor.h>
28
29#include <map>
30#include <vector>
31
32
33enum class KICURSOR
34{
35 DEFAULT,
36 ARROW,
37 MOVING,
38 PENCIL,
39 REMOVE,
40 HAND,
44 TUNE,
45 TEXT,
46 MEASURE,
47 ADD,
49 XOR,
50 ZOOM_IN,
62 PLACE
63};
64
72{
73public:
78 {
81
83 const unsigned char* m_image_data;
84
86 const unsigned char* m_mask_data;
87
88 const char** m_xpm;
89
91 wxSize m_size;
92
94 wxPoint m_hotspot;
95 };
96
105 CURSOR_STORE( const std::vector<CURSOR_DEF>& aDefs );
106
112 const wxCursor& Get( KICURSOR aIdKey ) const;
113
114 static const wxCursor GetCursor( KICURSOR aCursorType );
115
116 static const wxStockCursor GetStockCursor( KICURSOR aCursorType );
117
118private:
120 std::map<KICURSOR, wxCursor> m_store;
121};
122
123#endif // CURSOR_STORE__H
@ ADD
Definition: am_param.h:150
Store all of the related footprint information found in a netlist.
Definition: pcb_netlist.h:85
Simple class to construct and store cursors against unique ID keys.
Definition: cursors.h:72
static const wxStockCursor GetStockCursor(KICURSOR aCursorType)
Definition: cursors.cpp:408
const wxCursor & Get(KICURSOR aIdKey) const
Get a given cursor by its ID.
Definition: cursors.cpp:381
static const wxCursor GetCursor(KICURSOR aCursorType)
Definition: cursors.cpp:394
CURSOR_STORE(const std::vector< CURSOR_DEF > &aDefs)
Construct a store with a pre-set list of cursors.
Definition: cursors.cpp:372
std::map< KICURSOR, wxCursor > m_store
< Internal store of cursors by ID
Definition: cursors.h:120
KICURSOR
Definition: cursors.h:34
Definition of a cursor.
Definition: cursors.h:78
const unsigned char * m_image_data
The mask data bitmap.
Definition: cursors.h:83
KICURSOR m_id_key
< The ID key used to uniquely identify a cursor in a given store
Definition: cursors.h:80
const char ** m_xpm
The image size in pixels.
Definition: cursors.h:88
const unsigned char * m_mask_data
Definition: cursors.h:86
wxSize m_size
The "hotspot" where the cursor "is" in the image.
Definition: cursors.h:91