kicad/include/bitmap_types.h

114 lines
3.7 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007-2017 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 1992-2018 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, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef BITMAP_TYPES_H_
#define BITMAP_TYPES_H_
//FIXME: cannot include only this file in wxWidgets 2.9.3
// test if it works under stable release
// #include <wx/bitmap.h> // only to define wxBitmap
class wxBitmap; // only to define wxBitmap
class EDA_BASE_FRAME;
class EDA_DRAW_FRAME;
class wxWindow;
class wxAuiToolBar;
#include <config.h>
#include <wx/gdicmn.h> // wxBitmapType
/// PNG memory record (file in memory).
struct BITMAP_OPAQUE
{
const unsigned char* png;
int byteCount;
const char* name; // for debug, or future lazy dynamic linking
};
// declared as single element _array_, so its name assigns to pointer
#define EXTERN_BITMAP( x ) extern const BITMAP_OPAQUE x[1];
/// a BITMAP_DEF is really a const pointer to an opaque
/// structure. So you should never need to use 'const' with it.
typedef const BITMAP_OPAQUE *BITMAP_DEF;
/**
* Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
*/
wxBitmap KiBitmap( BITMAP_DEF aBitmap );
/**
* Construct a wxBitmap from a memory record, scaling it if device DPI demands it.
*
* Internally this may use caching to avoid scaling the same image twice. If caching
* is used, it's guaranteed threadsafe.
*
* @param aBitmap bitmap definition
* @param aWindow target window for scaling context
*/
wxBitmap KiScaledBitmap( BITMAP_DEF aBitmap, EDA_BASE_FRAME* aWindow );
/**
* Overload of the above function that takes another wxBitmap as a parameter.
*
* @param aBitmap bitmap definition
* @param aWindow target window for scaling context
*/
wxBitmap KiScaledBitmap( const wxBitmap& aBitmap, EDA_BASE_FRAME* aWindow );
/**
* Add a separator to the given toolbar scaled the same way as KiScaledBitmap.
*/
void KiScaledSeparator( wxAuiToolBar* aToolbar, EDA_BASE_FRAME* aWindow );
/**
* Return the automatic scale factor that would be used for a given window by
* KiScaledBitmap and KiScaledSeparator.
*/
int KiIconScale( wxWindow* aWindow );
/**
* Allocate a wxBitmap on heap from a memory record, held in a BITMAP_DEF.
*
* @return wxBitmap* - caller owns it.
*/
wxBitmap* KiBitmapNew( BITMAP_DEF aBitmap );
/**
* Save the current view as an image file.
*
* @param aFrame The current draw frame view to save.
* @param aFileName The file name to save the image. This will overwrite an exisiting file.
* @param aBitmapType The type of bitmap create as defined by wxImage.
* @return True if the file was successfully saved or false if the file failed to be saved.
*/
bool SaveCanvasImageToFile( EDA_DRAW_FRAME* aFrame, const wxString& aFileName,
wxBitmapType aBitmapType = wxBITMAP_TYPE_PNG );
#endif // BITMAP_TYPES_H_