gr_text.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2009-2014 Jerry Jacobs
 * Copyright (C) 1992-2023 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 GR_TEXT_H
#define GR_TEXT_H
 
#include <eda_item.h>
#include <font/text_attributes.h>
 
namespace KIGFX
{
 class COLOR4D;
}
 
#define MIN_TEXT_SIZE 5
 
/* Absolute minimum dimension in pixel to draw a text as text or a line
 * When a text height is smaller than MIN_DRAWABLE_TEXT_SIZE,
 * it is drawn, but like a line by the draw text function
*/
#define MIN_DRAWABLE_TEXT_SIZE 3
 
class PLOTTER;
 
int Clamp_Text_PenSize( int aPenSize, int aSize, bool aStrict = false );
float Clamp_Text_PenSize( float aPenSize, int aSize, bool aStrict = false );
int Clamp_Text_PenSize( int aPenSize, const VECTOR2I& aSize, bool aStrict = false );
 
int GetPenSizeForBold( int aTextSize );
int GetPenSizeForBold( const wxSize& aTextSize );
 
int GetPenSizeForDemiBold( int aTextSize );
int GetPenSizeForDemiBold( const wxSize& aTextSize );
 
int GetPenSizeForNormal( int aTextSize );
int GetPenSizeForNormal( const wxSize& aTextSize );
 
inline void InferBold( TEXT_ATTRIBUTES* aAttrs )
{
 int penSize( aAttrs->m_StrokeWidth );
 wxSize textSize( aAttrs->m_Size.x, aAttrs->m_Size.y );
 
 aAttrs->m_Bold = abs( penSize - GetPenSizeForBold( textSize ) )
 < abs( penSize - GetPenSizeForNormal( textSize ) );
}
 
 
inline int GetKnockoutTextMargin( const VECTOR2I& aSize, int aThickness )
{
 return std::max( KiROUND( aThickness / 2 ), KiROUND( aSize.y / 9.0 ) );
}
 
 
int GraphicTextWidth( const wxString& aText, KIFONT::FONT* aFont, const VECTOR2I& aSize,
 int aThickness, bool aBold, bool aItalic );
 
void GRPrintText( wxDC* aDC, const VECTOR2I& aPos, const KIGFX::COLOR4D& aColor,
 const wxString& aText, const EDA_ANGLE& aOrient, const VECTOR2I& aSize,
 enum GR_TEXT_H_ALIGN_T aH_justify, enum GR_TEXT_V_ALIGN_T aV_justify,
 int aWidth, bool aItalic, bool aBold, KIFONT::FONT* aFont );
 
 
#endif /* GR_TEXT_H */