kicad/pcbnew/dialogs/dialog_edit_footprint_text.cpp

387 lines
10 KiB
C++
Raw Normal View History

/**
* @file dialog_edit_module_text.cpp
* @brief dialog editor for texts (fields) in footprints.
*/
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2015 Jean-Pierre Charras
* Copyright (C) 2013 Dick Hollenbeck, dick@softplc.com
* Copyright (C) 2008 Wayne Stambaugh <stambaughw@gmail.com>
* Copyright (C) 1992-2017 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
*/
#include <fctsys.h>
#include <macros.h>
#include <gr_basic.h>
#include <common.h>
#include <class_drawpanel.h>
#include <pcbnew.h>
2018-01-28 21:02:31 +00:00
#include <draw_graphic_text.h>
#include <confirm.h>
2018-01-29 15:39:40 +00:00
#include <pcb_base_frame.h>
#include <base_units.h>
#include <wx/numformatter.h>
#include <board_commit.h>
#include <widgets/text_ctrl_eval.h>
#include <class_module.h>
#include <class_text_mod.h>
#include <class_board.h>
2018-01-31 08:23:20 +00:00
#include <pcb_layer_box_selector.h>
2018-02-16 16:52:19 +00:00
#include <dialog_edit_footprint_text.h>
extern wxPoint MoveVector; // Move vector for move edge, imported from edtxtmod.cpp
void PCB_BASE_FRAME::InstallTextModOptionsFrame( TEXTE_MODULE* TextMod, wxDC* DC )
{
m_canvas->SetIgnoreMouseEvents( true );
DIALOG_EDIT_FPTEXT dialog( this, this, TextMod, DC );
2009-08-11 10:27:21 +00:00
dialog.ShowModal();
m_canvas->SetIgnoreMouseEvents( false );
}
DIALOG_EDIT_FPTEXT::DIALOG_EDIT_FPTEXT( wxWindow* aCaller, PCB_BASE_FRAME* aBoardEditor,
TEXTE_MODULE* aTextMod, wxDC* aDC ) :
DIALOG_EDIT_FPTEXT_BASE( aCaller ), m_OrientValidator( 1, &m_OrientValue )
{
m_boardEditor = aBoardEditor;
m_dc = aDC;
m_module = NULL;
m_currentText = aTextMod;
m_OrientValue = 0;
m_OrientValidator.SetRange( -180.0, 180.0 );
m_OrientValueCtrl->SetValidator( m_OrientValidator );
m_OrientValidator.SetWindow( m_OrientValueCtrl );
if( m_currentText )
m_module = (MODULE*) m_currentText->GetParent();
2016-07-15 10:05:13 +00:00
m_sdbSizerOK->SetDefault();
SetFocus();
2016-07-15 10:05:13 +00:00
}
bool DIALOG_EDIT_FPTEXT::TransferDataToWindow()
{
if( !wxDialog::TransferDataToWindow() )
return false;
wxString msg;
if( m_module )
{
wxString format = m_ModuleInfoText->GetLabel();
msg.Printf( format,
GetChars( m_module->GetReference() ),
GetChars( m_module->GetValue() ),
m_module->GetOrientation() / 10.0 );
}
2009-08-11 10:27:21 +00:00
else
{
2009-08-11 10:27:21 +00:00
msg.Empty();
}
2009-08-11 10:27:21 +00:00
m_ModuleInfoText->SetLabel( msg );
// Create a list of not allowed layers.
// could be slightly dependent of the type of footprint text.
LSET forbiddenLayers( LSET::AllCuMask() );
forbiddenLayers.set( Edge_Cuts ).set( Margin ).set( F_Paste ).set( B_Paste ).set( F_Mask ).set( B_Mask );
switch( m_currentText->GetType() )
{
case TEXTE_MODULE::TEXT_is_VALUE:
m_TextDataTitle->SetLabel( _( "Value:" ) );
break;
case TEXTE_MODULE::TEXT_is_DIVERS:
m_TextDataTitle->SetLabel( _( "Text:" ) );
break;
case TEXTE_MODULE::TEXT_is_REFERENCE:
m_TextDataTitle->SetLabel( _( "Reference:" ) );
break;
}
m_Name->SetValue( m_currentText->GetText() );
m_Style->SetSelection( m_currentText->IsItalic() ? 1 : 0 );
AddUnitSymbol( *m_SizeXTitle );
PutValueInLocalUnits( *m_TxtSizeCtrlX, m_currentText->GetTextWidth() );
AddUnitSymbol( *m_SizeYTitle );
PutValueInLocalUnits( *m_TxtSizeCtrlY, m_currentText->GetTextHeight() );
AddUnitSymbol( *m_PosXTitle );
PutValueInLocalUnits( *m_TxtPosCtrlX, m_currentText->GetPos0().x );
AddUnitSymbol( *m_PosYTitle );
PutValueInLocalUnits( *m_TxtPosCtrlY, m_currentText->GetPos0().y );
AddUnitSymbol( *m_WidthTitle );
PutValueInLocalUnits( *m_TxtWidthCtlr, m_currentText->GetThickness() );
double text_orient = m_currentText->GetTextAngle();
text_orient = NormalizeAngle180( text_orient );
2011-12-12 08:37:05 +00:00
if( !m_currentText->IsVisible() )
m_Show->SetSelection( 1 );
bool custom_orientation = false;
switch( int( text_orient ) )
{
case 0:
m_Orient->SetSelection( 0 );
break;
case 900:
case -2700:
m_Orient->SetSelection( 1 );
break;
case -900:
case 2700:
m_Orient->SetSelection( 2 );
break;
case -1800:
case 1800:
m_Orient->SetSelection( 3 );
break;
default:
m_Orient->SetSelection( 4 );
custom_orientation = true;
break;
}
m_OrientValueCtrl->Enable( custom_orientation );
m_OrientValue = text_orient / 10.0;
m_OrientValidator.TransferToWindow();
m_unlock->SetValue( m_currentText->IsUnlocked() );
// Configure the layers list selector
if( !m_boardEditor->GetBoard()->IsLayerEnabled( m_currentText->GetLayer() ) )
// Footprints are built outside the current board, so items cann be
// on a not activated layer, therefore show it if happens.
m_LayerSelectionCtrl->ShowNonActivatedLayers( true );
m_LayerSelectionCtrl->SetLayersHotkeys( false );
m_LayerSelectionCtrl->SetNotAllowedLayerSet( forbiddenLayers );
m_LayerSelectionCtrl->SetBoardFrame( m_boardEditor );
m_LayerSelectionCtrl->Resync();
if( m_LayerSelectionCtrl->SetLayerSelection( m_currentText->GetLayer() ) < 0 )
{
wxMessageBox( _( "This item has an illegal layer id.\n"
"Now, forced on the front silk screen layer. Please, fix it" ) );
m_LayerSelectionCtrl->SetLayerSelection( F_SilkS );
}
Layout();
return true;
}
bool DIALOG_EDIT_FPTEXT::TransferDataFromWindow()
{
BOARD_COMMIT commit( m_boardEditor );
if( !Validate() || !DIALOG_EDIT_FPTEXT_BASE::TransferDataFromWindow() )
return false;
if( m_module )
commit.Modify( m_currentText );
#ifndef USE_WX_OVERLAY
if( m_dc ) //Erase old text on screen
{
m_currentText->Draw( m_boardEditor->GetCanvas(), m_dc, GR_XOR,
(m_currentText->IsMoving()) ? MoveVector : wxPoint( 0, 0 ) );
}
#endif
m_currentText->SetText( m_Name->GetValue() );
m_currentText->SetItalic( m_Style->GetSelection() == 1 );
2011-12-12 08:37:05 +00:00
wxPoint tmp;
tmp.x = ValueFromString( g_UserUnit, m_TxtPosCtrlX->GetValue() );
tmp.y = ValueFromString( g_UserUnit, m_TxtPosCtrlY->GetValue() );
2011-12-12 08:37:05 +00:00
m_currentText->SetPos0( tmp );
* KIWAY Milestone A): Make major modules into DLL/DSOs. ! The initial testing of this commit should be done using a Debug build so that all the wxASSERT()s are enabled. Also, be sure and keep enabled the USE_KIWAY_DLLs option. The tree won't likely build without it. Turning it off is senseless anyways. If you want stable code, go back to a prior version, the one tagged with "stable". * Relocate all functionality out of the wxApp derivative into more finely targeted purposes: a) DLL/DSO specific b) PROJECT specific c) EXE or process specific d) configuration file specific data e) configuration file manipulations functions. All of this functionality was blended into an extremely large wxApp derivative and that was incompatible with the desire to support multiple concurrently loaded DLL/DSO's ("KIFACE")s and multiple concurrently open projects. An amazing amount of organization come from simply sorting each bit of functionality into the proper box. * Switch to wxConfigBase from wxConfig everywhere except instantiation. * Add classes KIWAY, KIFACE, KIFACE_I, SEARCH_STACK, PGM_BASE, PGM_KICAD, PGM_SINGLE_TOP, * Remove "Return" prefix on many function names. * Remove obvious comments from CMakeLists.txt files, and from else() and endif()s. * Fix building boost for use in a DSO on linux. * Remove some of the assumptions in the CMakeLists.txt files that windows had to be the host platform when building windows binaries. * Reduce the number of wxStrings being constructed at program load time via static construction. * Pass wxConfigBase* to all SaveSettings() and LoadSettings() functions so that these functions are useful even when the wxConfigBase comes from another source, as is the case in the KICAD_MANAGER_FRAME. * Move the setting of the KIPRJMOD environment variable into class PROJECT, so that it can be moved into a project variable soon, and out of FP_LIB_TABLE. * Add the KIWAY_PLAYER which is associated with a particular PROJECT, and all its child wxFrames and wxDialogs now have a Kiway() member function which returns a KIWAY& that that window tree branch is in support of. This is like wxWindows DNA in that child windows get this member with proper value at time of construction. * Anticipate some of the needs for milestones B) and C) and make code adjustments now in an effort to reduce work in those milestones. * No testing has been done for python scripting, since milestone C) has that being largely reworked and re-thought-out.
2014-03-20 00:42:08 +00:00
wxSize textSize( wxSize( ValueFromString( g_UserUnit, m_TxtSizeCtrlX->GetValue() ),
ValueFromString( g_UserUnit, m_TxtSizeCtrlY->GetValue() ) ) );
// Test for a reasonable size:
if( textSize.x < TEXTS_MIN_SIZE )
textSize.x = TEXTS_MIN_SIZE;
if( textSize.y < TEXTS_MIN_SIZE )
textSize.y = TEXTS_MIN_SIZE;
m_currentText->SetTextSize( textSize );
int width = ValueFromString( g_UserUnit, m_TxtWidthCtlr->GetValue() );
// Test for a reasonable width:
if( width <= 1 )
width = 1;
int maxthickness = Clamp_Text_PenSize(width, m_currentText->GetTextSize() );
if( width > maxthickness )
{
DisplayError( NULL,
_( "The text thickness is too large for the text size. It will be clamped" ) );
width = maxthickness;
}
m_currentText->SetThickness( width );
2011-12-12 08:37:05 +00:00
m_currentText->SetVisible( m_Show->GetSelection() == 0 );
bool custom_orientation = false;
switch( m_Orient->GetSelection() )
{
case 0:
m_currentText->SetTextAngle( 0 );
break;
case 1:
m_currentText->SetTextAngle( 900 );
break;
case 2:
m_currentText->SetTextAngle( -900 );
break;
case 3:
m_currentText->SetTextAngle( 1800 );
break;
default:
custom_orientation = true;
m_currentText->SetTextAngle( KiROUND( m_OrientValue * 10.0 ) );
break;
};
switch( int( m_currentText->GetTextAngle() ) )
{
case 0:
m_Orient->SetSelection( 0 );
break;
case 900:
case -2700:
m_Orient->SetSelection( 1 );
break;
case -900:
case 2700:
m_Orient->SetSelection( 2 );
break;
case -1800:
case 1800:
m_Orient->SetSelection( 3 );
break;
default:
m_Orient->SetSelection( 4 );
m_currentText->SetTextAngle( KiROUND( m_OrientValue * 10.0 ) );
custom_orientation = true;
break;
}
m_OrientValue = 10.0 * m_currentText->GetTextAngle();
m_OrientValueCtrl->Enable( custom_orientation );
m_OrientValidator.TransferToWindow();
m_currentText->SetDrawCoord();
m_currentText->SetUnlocked( m_unlock->GetValue() );
LAYER_NUM layer = m_LayerSelectionCtrl->GetLayerSelection();
m_currentText->SetLayer( ToLAYER_ID( layer ) );
m_currentText->SetMirrored( IsBackLayer( m_currentText->GetLayer() ) );
#ifndef USE_WX_OVERLAY
if( m_dc ) // Display new text
{
m_currentText->Draw( m_boardEditor->GetCanvas(), m_dc, GR_XOR,
(m_currentText->IsMoving()) ? MoveVector : wxPoint( 0, 0 ) );
}
#else
m_boardEditor->Refresh();
#endif
commit.Push( _( "Modify module text" ) );
if( m_module )
m_module->SetLastEditTime();
return true;
}
void DIALOG_EDIT_FPTEXT::ModuleOrientEvent( wxCommandEvent& event )
{
bool custom_orientation = false;
switch( m_Orient->GetSelection() )
{
case 0:
m_OrientValue = 0.0;
break;
case 1:
m_OrientValue = 90.0;
break;
case 2:
m_OrientValue = -90.0;
break;
case 3:
m_OrientValue = 180.0;
break;
default:
custom_orientation = true;
break;
}
m_OrientValidator.TransferToWindow();
m_OrientValueCtrl->Enable( custom_orientation );
}