KiCad PCB EDA Suite
cursor_store.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 KiCad Developers, see CHANGELOG.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 
40 {
41 public:
45  struct CURSOR_DEF
46  {
48  int m_id_key;
49 
51  const unsigned char* m_image_data;
52 
54  const unsigned char* m_mask_data;
55 
57  wxSize m_size;
58 
61  };
62 
71  CURSOR_STORE( const std::vector<CURSOR_DEF>& aDefs );
72 
78  const wxCursor& Get( int aIdKey ) const;
79 
80 private:
82  std::map<int, wxCursor> m_store;
83 };
84 
85 #endif // CURSOR_STORE__H
int m_id_key
The ID key used to uniquely identify a cursor in a given store
Definition: cursor_store.h:48
const unsigned char * m_mask_data
The mask data bitmap
Definition: cursor_store.h:54
const unsigned char * m_image_data
The image data bitmap
Definition: cursor_store.h:51
Simple class to construct and store cursors against unique ID keys.
Definition: cursor_store.h:39
Definition of a cursor.
Definition: cursor_store.h:45
wxSize m_size
The image size in pixels
Definition: cursor_store.h:57
wxPoint m_hotspot
The "hotspot" where the cursor "is" in the image
Definition: cursor_store.h:60
const wxCursor & Get(int aIdKey) const
Get a given cursor by its ID.
CURSOR_STORE(const std::vector< CURSOR_DEF > &aDefs)
Construct a store with a pre-set list of cursors.
std::map< int, wxCursor > m_store
Internal store of cursors by ID
Definition: cursor_store.h:82