diff options
Diffstat (limited to 'include/drawtxt.h')
| -rw-r--r-- | include/drawtxt.h | 155 |
1 files changed, 155 insertions, 0 deletions
diff --git a/include/drawtxt.h b/include/drawtxt.h new file mode 100644 index 0000000..9f4ad95 --- /dev/null +++ b/include/drawtxt.h @@ -0,0 +1,155 @@ +/* + * This program source code file is part of KiCad, a free EDA CAD application. + * + * Copyright (C) 2009-2014 Jerry Jacobs + * Copyright (C) 1992-2014 KiCad Developers, see CHANGELOG.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 + */ + +/** + * This file is part of the common libary + * @file drawtxt.h + * @see common.h + */ + +#ifndef __INCLUDE__DRAWTXT_H__ +#define __INCLUDE__DRAWTXT_H__ 1 + +#include <base_struct.h> +#include <eda_text.h> // EDA_TEXT_HJUSTIFY_T and EDA_TEXT_VJUSTIFY_T + +/* Minimum dimension in pixel for drawing/no drawing a text + * used in Pcbnew to decide to draw (or not) some texts + * ( like net names on pads/tracks ) + * When a text height is smaller than MIN_TEXT_SIZE, + * it is not drawn by Pcbnew + */ +#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 EDA_DRAW_PANEL; +class PLOTTER; + +/** + * Function Clamp_Text_PenSize + *As a rule, pen width should not be >1/4em, otherwise the character + * will be cluttered up in its own fatness + * The pen width max is aSize/4 for bold texts, and aSize/6 for normal texts + * The "best" pen width is aSize/5 for bold texts, + * so the clamp is consistant with bold option. + * @param aPenSize = the pen size to clamp + * @param aSize the char size (height or width, od its wxSize) + * @param aBold = true if text accept bold pen size + * @return the max pen size allowed + */ +int Clamp_Text_PenSize( int aPenSize, int aSize, bool aBold = true ); +int Clamp_Text_PenSize( int aPenSize, wxSize aSize, bool aBold = true ); + +/** + * Function GetPensizeForBold + * @return the "best" value for a pen size to draw/plot a bold text + * @param aTextSize = the char size (height or width) + */ +int GetPenSizeForBold( int aTextSize ); + +/** + * Function GraphicTextWidth + * @return the X size of the graphic text + * the full X size is GraphicTextWidth + the thickness of graphic lines + */ +int GraphicTextWidth( const wxString& aText, int size_h, bool italic, bool bold ); + +/** + * Function NegableTextLength + * Return the text length of a negable string, excluding the ~ markers */ +int NegableTextLength( const wxString& aText ); + +/** + * Helper function for texts with over bar, can be used as strut value + * for multiline text (add interline spacing) + */ +int OverbarPositionY( int size_v ); + +/** + * Function DrawGraphicText + * Draw a graphic text (like module texts) + * @param aClipBox = the clipping rect, or NULL if no clipping + * @param aDC = the current Device Context. NULL if draw within a 3D GL Canvas + * @param aPos = text position (according to h_justify, v_justify) + * @param aColor (enum EDA_COLOR_T) = text color + * @param aText = text to draw + * @param aOrient = angle in 0.1 degree + * @param aSize = text size (size.x or size.y can be < 0 for mirrored texts) + * @param aH_justify = horizontal justification (Left, center, right) + * @param aV_justify = vertical justification (bottom, center, top) + * @param aWidth = line width (pen width) (default = 0) + * if width < 0 : draw segments in sketch mode, width = abs(width) + * Use a value min(aSize.x, aSize.y) / 5 for a bold text + * @param aItalic = true to simulate an italic font + * @param aBold = true to use a bold font + * @param aCallback() = function called (if non null) to draw each segment. + * used to draw 3D texts or for plotting, NULL for normal drawings + * @param aPlotter = a pointer to a PLOTTER instance, when this function is used to plot + * the text. NULL to draw this text. + */ +void DrawGraphicText( EDA_RECT* aClipBox, + wxDC * aDC, + const wxPoint &aPos, + enum EDA_COLOR_T aColor, + const wxString &aText, + double aOrient, + const wxSize &aSize, + enum EDA_TEXT_HJUSTIFY_T aH_justify, + enum EDA_TEXT_VJUSTIFY_T aV_justify, + int aWidth, + bool aItalic, + bool aBold, + void (*aCallback)( int x0, int y0, int xf, int yf ) = NULL, + PLOTTER * aPlotter = NULL ); + + +/** + * Draw graphic text with a border, so that it can be read on different + * backgrounds. See DrawGraphicText for most of the parameters. + * If aBgColor is a dark color text is drawn in aColor2 with aColor1 + * border; otherwise colors are swapped. + */ +void DrawGraphicHaloText( EDA_RECT* aClipBox, + wxDC * aDC, + const wxPoint &aPos, + enum EDA_COLOR_T aBgColor, + enum EDA_COLOR_T aColor1, + enum EDA_COLOR_T aColor2, + const wxString &aText, + double aOrient, + const wxSize &aSize, + enum EDA_TEXT_HJUSTIFY_T aH_justify, + enum EDA_TEXT_VJUSTIFY_T aV_justify, + int aWidth, + bool aItalic, + bool aBold, + void (*aCallback)( int x0, int y0, int xf, int yf ) = NULL, + PLOTTER * aPlotter = NULL ); + +#endif /* __INCLUDE__DRAWTXT_H__ */ |