AllSpiceMirrors/kicad
7
Fork 0
mirror of https://gitlab.com/kicad/code/kicad.git synced 2025-04-20 00:11:41 +00:00
Files Issues Releases Activity

API: Expose title block info

Browse Source
This commit is contained in:
Jon Evans 2024-11-19 23:44:29 -05:00
parent 033fb4fc8f
commit af71ea869e
4 changed files with 64 additions and 0 deletions

6
api/proto/common/commands/editor_commands.proto
View File

@ -309,3 +309,9 @@ message HitTestResponse
{
HitTestResult result = 1;
}
// returns common.types.TitleBlockInfo
message GetTitleBlockInfo
{
kiapi.common.types.DocumentSpecifier document = 1;
}

21
api/proto/common/types/base_types.proto
View File

@ -338,3 +338,24 @@ message GraphicAttributes
StrokeAttributes stroke = 1;
GraphicFillAttributes fill = 2;
}
// The text strings that can be set in a drawing sheet for the title block
message TitleBlockInfo
{
string title = 1;
string date = 2;
string revision = 3;
string company = 4;
// Note: not a repeated string; there can be gaps and the UI limits the count to 9
string comment1 = 5;
string comment2 = 6;
string comment3 = 7;
string comment4 = 8;
string comment5 = 9;
string comment6 = 10;
string comment7 = 11;
string comment8 = 12;
string comment9 = 13;
}

34
pcbnew/api/api_handler_pcb.cpp
View File

@ -69,6 +69,8 @@ API_HANDLER_PCB::API_HANDLER_PCB( PCB_EDIT_FRAME* aFrame ) :
&API_HANDLER_PCB::handleGetTextExtents );
registerHandler<GetPadShapeAsPolygon, PadShapeAsPolygonResponse>(
&API_HANDLER_PCB::handleGetPadShapeAsPolygon );
registerHandler<GetTitleBlockInfo, types::TitleBlockInfo>(
&API_HANDLER_PCB::handleGetTitleBlockInfo );
registerHandler<InteractiveMoveItems, Empty>( &API_HANDLER_PCB::handleInteractiveMoveItems );
registerHandler<GetNets, NetsResponse>( &API_HANDLER_PCB::handleGetNets );
@ -683,6 +685,38 @@ HANDLER_RESULT<PadShapeAsPolygonResponse> API_HANDLER_PCB::handleGetPadShapeAsPo
}
HANDLER_RESULT<types::TitleBlockInfo> API_HANDLER_PCB::handleGetTitleBlockInfo(
GetTitleBlockInfo& aMsg,
const HANDLER_CONTEXT& aCtx )
{
HANDLER_RESULT<bool> documentValidation = validateDocument( aMsg.document() );
if( !documentValidation )
return tl::unexpected( documentValidation.error() );
BOARD* board = frame()->GetBoard();
const TITLE_BLOCK& block = board->GetTitleBlock();
types::TitleBlockInfo response;
response.set_title( block.GetTitle().ToUTF8() );
response.set_date( block.GetDate().ToUTF8() );
response.set_revision( block.GetRevision().ToUTF8() );
response.set_company( block.GetCompany().ToUTF8() );
response.set_comment1( block.GetComment( 0 ).ToUTF8() );
response.set_comment2( block.GetComment( 1 ).ToUTF8() );
response.set_comment3( block.GetComment( 2 ).ToUTF8() );
response.set_comment4( block.GetComment( 3 ).ToUTF8() );
response.set_comment5( block.GetComment( 4 ).ToUTF8() );
response.set_comment6( block.GetComment( 5 ).ToUTF8() );
response.set_comment7( block.GetComment( 6 ).ToUTF8() );
response.set_comment8( block.GetComment( 7 ).ToUTF8() );
response.set_comment9( block.GetComment( 8 ).ToUTF8() );
return response;
}
HANDLER_RESULT<Empty> API_HANDLER_PCB::handleInteractiveMoveItems( InteractiveMoveItems& aMsg,
const HANDLER_CONTEXT& aCtx )
{

3
pcbnew/api/api_handler_pcb.h
View File

@ -81,6 +81,9 @@ private:
HANDLER_RESULT<PadShapeAsPolygonResponse> handleGetPadShapeAsPolygon( GetPadShapeAsPolygon& aMsg,
const HANDLER_CONTEXT& aCtx );
HANDLER_RESULT<types::TitleBlockInfo> handleGetTitleBlockInfo( commands::GetTitleBlockInfo& aMsg,
const HANDLER_CONTEXT& aCtx );
HANDLER_RESULT<Empty> handleInteractiveMoveItems( InteractiveMoveItems& aMsg,
const HANDLER_CONTEXT& aCtx );