355 lines
12 KiB
C++
355 lines
12 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2004-2010 Jean-Pierre Charras <jean-pierre.charras@gpisa-lab.inpg.fr>
|
|
* Copyright (C) 2010-2016 KiCad Developers, see change_log.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
|
|
*/
|
|
|
|
/***************************************************************************/
|
|
/* Dialog editor for text on copper and technical layers (TEXTE_PCB class) */
|
|
/***************************************************************************/
|
|
|
|
#include <fctsys.h>
|
|
#include <gr_basic.h>
|
|
#include <class_drawpanel.h>
|
|
#include <pcbnew.h>
|
|
#include <wxPcbStruct.h>
|
|
#include <drawtxt.h>
|
|
#include <confirm.h>
|
|
#include <base_units.h>
|
|
#include <wx/valnum.h>
|
|
#include <widgets/text_ctrl_eval.h>
|
|
|
|
#include <class_board.h>
|
|
#include <class_pcb_text.h>
|
|
|
|
#include <vector>
|
|
#include <wx/wx.h>
|
|
#include <dialog_pcb_text_properties_base.h>
|
|
#include <class_pcb_layer_box_selector.h>
|
|
#include <board_commit.h>
|
|
|
|
|
|
class PCB_EDIT_FRAME;
|
|
class TEXTE_PCB;
|
|
|
|
|
|
class DIALOG_PCB_TEXT_PROPERTIES : public DIALOG_PCB_TEXT_PROPERTIES_BASE
|
|
{
|
|
public:
|
|
DIALOG_PCB_TEXT_PROPERTIES( PCB_EDIT_FRAME* parent, TEXTE_PCB* passedTextPCB, wxDC* DC = nullptr );
|
|
~DIALOG_PCB_TEXT_PROPERTIES();
|
|
|
|
private:
|
|
PCB_EDIT_FRAME* m_Parent;
|
|
wxDC* m_DC;
|
|
TEXTE_PCB* m_SelectedPCBText;
|
|
|
|
wxFloatingPointValidator<double> m_OrientValidator;
|
|
double m_OrientValue;
|
|
|
|
bool TransferDataToWindow() override;
|
|
bool TransferDataFromWindow() override;
|
|
|
|
// Virtual event handler
|
|
virtual void OnInitDlg( wxInitDialogEvent& event ) override
|
|
{
|
|
// Call the default wxDialog handler of a wxInitDialogEvent
|
|
TransferDataToWindow();
|
|
|
|
// Now all widgets have the size fixed, call FinishDialogSettings
|
|
FinishDialogSettings();
|
|
}
|
|
|
|
void OnCharHook( wxKeyEvent& aEvent );
|
|
};
|
|
|
|
|
|
/**
|
|
* DIALOG_PCB_TEXT_PROPERTIES, derived from DIALOG_PCB_TEXT_PROPERTIES_BASE
|
|
* @see dialog_dialog_pcb_text_properties_base.h and
|
|
* dialog_dialog_pcb_text_properties_base.cpp, automatically created by
|
|
* wxFormBuilder.
|
|
*/
|
|
|
|
DIALOG_PCB_TEXT_PROPERTIES::DIALOG_PCB_TEXT_PROPERTIES( PCB_EDIT_FRAME* parent,
|
|
TEXTE_PCB* passedTextPCB, wxDC* DC ) :
|
|
DIALOG_PCB_TEXT_PROPERTIES_BASE( parent ),
|
|
m_OrientValidator( 1, &m_OrientValue )
|
|
{
|
|
m_Parent = parent;
|
|
m_DC = DC;
|
|
m_SelectedPCBText = passedTextPCB;
|
|
|
|
m_OrientValue = 0.0;
|
|
m_OrientValidator.SetRange( -360.0, 360.0 );
|
|
m_OrientCtrl->SetValidator( m_OrientValidator );
|
|
m_OrientValidator.SetWindow( m_OrientCtrl );
|
|
|
|
m_StandardSizerOK->SetDefault();
|
|
|
|
// wxTextCtrls fail to generate wxEVT_CHAR events when the wxTE_MULTILINE flag is set,
|
|
// so we have to listen to wxEVT_CHAR_HOOK events instead.
|
|
m_TextContentCtrl->Connect( wxEVT_CHAR_HOOK,
|
|
wxKeyEventHandler( DIALOG_PCB_TEXT_PROPERTIES::OnCharHook ),
|
|
NULL, this );
|
|
}
|
|
|
|
|
|
DIALOG_PCB_TEXT_PROPERTIES::~DIALOG_PCB_TEXT_PROPERTIES()
|
|
{
|
|
m_TextContentCtrl->Disconnect( wxEVT_CHAR_HOOK,
|
|
wxKeyEventHandler( DIALOG_PCB_TEXT_PROPERTIES::OnCharHook ),
|
|
NULL, this );
|
|
}
|
|
|
|
|
|
/**
|
|
* Routine for main window class to launch text properties dialog.
|
|
*/
|
|
void PCB_EDIT_FRAME::InstallTextPCBOptionsFrame( TEXTE_PCB* TextPCB, wxDC* DC )
|
|
{
|
|
m_canvas->SetIgnoreMouseEvents( true );
|
|
#ifndef __WXMAC__
|
|
DIALOG_PCB_TEXT_PROPERTIES dlg( this, TextPCB, DC );
|
|
#else
|
|
// Avoid "writes" in the dialog, creates errors with WxOverlay and NSView
|
|
// Raising an Exception - Fixes #891347
|
|
DIALOG_PCB_TEXT_PROPERTIES dlg( this, TextPCB, NULL );
|
|
#endif
|
|
dlg.ShowModal();
|
|
m_canvas->MoveCursorToCrossHair();
|
|
m_canvas->SetIgnoreMouseEvents( false );
|
|
}
|
|
|
|
|
|
void DIALOG_PCB_TEXT_PROPERTIES::OnCharHook( wxKeyEvent& aEvent )
|
|
{
|
|
if( aEvent.GetKeyCode() == WXK_TAB )
|
|
{
|
|
int flags = 0;
|
|
if( !aEvent.ShiftDown() )
|
|
flags |= wxNavigationKeyEvent::IsForward;
|
|
if( aEvent.ControlDown() )
|
|
flags |= wxNavigationKeyEvent::WinChange;
|
|
NavigateIn( flags );
|
|
}
|
|
else if( aEvent.GetKeyCode() == WXK_RETURN && aEvent.ShiftDown() )
|
|
{
|
|
TransferDataFromWindow();
|
|
EndModal( 1 );
|
|
}
|
|
else
|
|
{
|
|
aEvent.Skip();
|
|
}
|
|
}
|
|
|
|
|
|
bool DIALOG_PCB_TEXT_PROPERTIES::TransferDataToWindow()
|
|
{
|
|
// Put units symbols to text labels where appropriate
|
|
AddUnitSymbol( *m_SizeXLabel );
|
|
AddUnitSymbol( *m_SizeYLabel );
|
|
AddUnitSymbol( *m_ThicknessLabel );
|
|
AddUnitSymbol( *m_PositionXLabel );
|
|
AddUnitSymbol( *m_PositionYLabel );
|
|
|
|
// Fill fields with current values
|
|
*m_TextContentCtrl << m_SelectedPCBText->GetText();
|
|
|
|
PutValueInLocalUnits( *m_SizeXCtrl, m_SelectedPCBText->GetTextWidth() );
|
|
PutValueInLocalUnits( *m_SizeYCtrl, m_SelectedPCBText->GetTextHeight() );
|
|
PutValueInLocalUnits( *m_ThicknessCtrl, m_SelectedPCBText->GetThickness() );
|
|
PutValueInLocalUnits( *m_PositionXCtrl, m_SelectedPCBText->GetTextPos().x );
|
|
PutValueInLocalUnits( *m_PositionYCtrl, m_SelectedPCBText->GetTextPos().y );
|
|
|
|
// Configure the layers list selector
|
|
m_LayerSelectionCtrl->SetLayersHotkeys( false );
|
|
|
|
// A text has no sense on edge cut layer
|
|
m_LayerSelectionCtrl->SetLayerSet( Edge_Cuts );
|
|
m_LayerSelectionCtrl->SetBoardFrame( m_Parent );
|
|
m_LayerSelectionCtrl->Resync();
|
|
m_LayerSelectionCtrl->SetLayerSelection( m_SelectedPCBText->GetLayer() );
|
|
|
|
m_OrientValue = m_SelectedPCBText->GetTextAngleDegrees();
|
|
|
|
if( m_SelectedPCBText->IsMirrored() )
|
|
m_DisplayCtrl->SetSelection( 1 );
|
|
else
|
|
m_DisplayCtrl->SetSelection( 0 );
|
|
|
|
if( m_SelectedPCBText->IsItalic() )
|
|
m_StyleCtrl->SetSelection( 1 );
|
|
else
|
|
m_StyleCtrl->SetSelection( 0 );
|
|
|
|
// Set justification
|
|
EDA_TEXT_HJUSTIFY_T hJustify = m_SelectedPCBText->GetHorizJustify();
|
|
m_justifyChoice->SetSelection( (int) hJustify + 1 );
|
|
|
|
// Manually set tab order
|
|
m_SizeXCtrl->MoveAfterInTabOrder( m_TextContentCtrl );
|
|
m_SizeYCtrl->MoveAfterInTabOrder( m_SizeXCtrl );
|
|
m_ThicknessCtrl->MoveAfterInTabOrder( m_SizeYCtrl );
|
|
m_PositionXCtrl->MoveAfterInTabOrder( m_ThicknessCtrl );
|
|
m_PositionYCtrl->MoveAfterInTabOrder( m_PositionXCtrl );
|
|
m_OrientCtrl->MoveAfterInTabOrder( m_PositionYCtrl );
|
|
m_LayerSelectionCtrl->MoveAfterInTabOrder( m_OrientCtrl );
|
|
m_StyleCtrl->MoveAfterInTabOrder( m_LayerSelectionCtrl );
|
|
m_DisplayCtrl->MoveAfterInTabOrder( m_StyleCtrl );
|
|
m_justifyChoice->MoveAfterInTabOrder( m_DisplayCtrl );
|
|
|
|
// Set focus on most important control
|
|
m_TextContentCtrl->SetFocus();
|
|
m_TextContentCtrl->SetSelection( -1, -1 );
|
|
|
|
return DIALOG_PCB_TEXT_PROPERTIES_BASE::TransferDataToWindow();
|
|
}
|
|
|
|
|
|
bool DIALOG_PCB_TEXT_PROPERTIES::TransferDataFromWindow()
|
|
{
|
|
if( !DIALOG_PCB_TEXT_PROPERTIES_BASE::TransferDataFromWindow() )
|
|
return false;
|
|
|
|
BOARD_COMMIT commit( m_Parent );
|
|
commit.Modify( m_SelectedPCBText );
|
|
|
|
// Test for acceptable layer.
|
|
// Incorrect layer can happen for old boards,
|
|
// having texts on edge cut layer for instance
|
|
if( m_LayerSelectionCtrl->GetLayerSelection() < 0 )
|
|
{
|
|
wxMessageBox( _( "No layer selected, Please select the text layer" ) );
|
|
return false;
|
|
}
|
|
|
|
wxPoint newPosition;
|
|
wxSize newSize;
|
|
|
|
// If no other command in progress, prepare undo command
|
|
// (for a command in progress, will be made later, at the completion of command)
|
|
bool pushCommit = ( m_SelectedPCBText->GetFlags() == 0 );
|
|
|
|
/* set flag in edit to force undo/redo/abort proper operation,
|
|
* and avoid new calls to SaveCopyInUndoList for the same text
|
|
* this can occurs when a text is moved, and then rotated, edited ..
|
|
*/
|
|
if( m_SelectedPCBText->GetFlags() != 0 )
|
|
m_SelectedPCBText->SetFlags( IN_EDIT );
|
|
|
|
#ifndef USE_WX_OVERLAY
|
|
// Erase old text on screen if context is available
|
|
if( m_DC )
|
|
{
|
|
m_SelectedPCBText->Draw( m_Parent->GetCanvas(), m_DC, GR_XOR );
|
|
}
|
|
#endif
|
|
|
|
// Set the new text content
|
|
if( !m_TextContentCtrl->GetValue().IsEmpty() )
|
|
{
|
|
m_SelectedPCBText->SetText( m_TextContentCtrl->GetValue() );
|
|
}
|
|
|
|
// Set PCB Text position
|
|
newPosition.x = ValueFromString( g_UserUnit, m_PositionXCtrl->GetValue() );
|
|
newPosition.y = ValueFromString( g_UserUnit, m_PositionYCtrl->GetValue() );
|
|
m_SelectedPCBText->SetTextPos( newPosition );
|
|
|
|
// Check constraints and set PCB Text size
|
|
newSize.x = ValueFromString( g_UserUnit, m_SizeXCtrl->GetValue() );
|
|
newSize.y = ValueFromString( g_UserUnit, m_SizeYCtrl->GetValue() );
|
|
|
|
if( newSize.x < TEXTS_MIN_SIZE )
|
|
newSize.x = TEXTS_MIN_SIZE;
|
|
|
|
if( newSize.y < TEXTS_MIN_SIZE )
|
|
newSize.y = TEXTS_MIN_SIZE;
|
|
|
|
if( newSize.x > TEXTS_MAX_WIDTH )
|
|
newSize.x = TEXTS_MAX_WIDTH;
|
|
|
|
if( newSize.y > TEXTS_MAX_WIDTH )
|
|
newSize.y = TEXTS_MAX_WIDTH;
|
|
|
|
m_SelectedPCBText->SetTextSize( newSize );
|
|
|
|
// Set the new thickness
|
|
m_SelectedPCBText->SetThickness( ValueFromString( g_UserUnit,
|
|
m_ThicknessCtrl->GetValue() ) );
|
|
|
|
// Test for acceptable values for thickness and size and clamp if fails
|
|
int maxthickness = Clamp_Text_PenSize( m_SelectedPCBText->GetThickness(),
|
|
m_SelectedPCBText->GetTextSize() );
|
|
|
|
if( m_SelectedPCBText->GetThickness() > maxthickness )
|
|
{
|
|
DisplayError( NULL,
|
|
_( "The text thickness is too large for the text size. It will be clamped" ) );
|
|
m_SelectedPCBText->SetThickness( maxthickness );
|
|
}
|
|
|
|
// Set the layer on which the PCB text is laying
|
|
m_SelectedPCBText->SetLayer( ToLAYER_ID( m_LayerSelectionCtrl->GetLayerSelection() ) );
|
|
|
|
// Set whether the PCB text is mirrored (faced down from layer face perspective)
|
|
m_SelectedPCBText->SetMirrored( m_DisplayCtrl->GetSelection() == 1 );
|
|
|
|
// Set the text angle
|
|
m_SelectedPCBText->SetTextAngle( m_OrientValue * 10.0 );
|
|
|
|
// Set whether the PCB text is slanted (it is not italics, as italics has additional curves in style)
|
|
m_SelectedPCBText->SetItalic( m_StyleCtrl->GetSelection() );
|
|
|
|
// Set justification
|
|
switch( m_justifyChoice->GetSelection() )
|
|
{
|
|
case 0:
|
|
m_SelectedPCBText->SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
|
|
break;
|
|
case 1:
|
|
m_SelectedPCBText->SetHorizJustify( GR_TEXT_HJUSTIFY_CENTER );
|
|
break;
|
|
case 2:
|
|
m_SelectedPCBText->SetHorizJustify( GR_TEXT_HJUSTIFY_RIGHT );
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
|
|
#ifndef USE_WX_OVERLAY
|
|
// Finally, display new text if there is a context to do so
|
|
if( m_DC )
|
|
{
|
|
m_SelectedPCBText->Draw( m_Parent->GetCanvas(), m_DC, GR_OR );
|
|
}
|
|
#else
|
|
m_Parent->Refresh();
|
|
#endif
|
|
|
|
if( pushCommit )
|
|
commit.Push( _( "Change text properties" ) );
|
|
|
|
return true;
|
|
}
|