KiCad PCB EDA Suite
Loading...
Searching...
No Matches
ds_painter.h File Reference
#include <gal/color4d.h>
#include <gal/painter.h>
#include <page_info.h>
#include <drawing_sheet/ds_draw_item.h>

Go to the source code of this file.

Classes

class  KIGFX::DS_RENDER_SETTINGS
 Store page-layout-specific render settings. More...
 
class  KIGFX::DS_PAINTER
 Methods for painting drawing sheet items. More...
 

Namespaces

namespace  KIGFX
 The Cairo implementation of the graphics abstraction layer.
 

Functions

void PrintDrawingSheet (const RENDER_SETTINGS *aSettings, const PAGE_INFO &aPageInfo, const wxString &aSheetName, const wxString &aSheetPath, const wxString &aFileName, const TITLE_BLOCK &aTitleBlock, const std::map< wxString, wxString > *aProperties, int aSheetCount, const wxString &aPageNumber, double aScalar, const PROJECT *aProject, const wxString &aSheetLayer=wxEmptyString, bool aIsFirstPage=true)
 Print the border and title block.
 

Function Documentation

◆ PrintDrawingSheet()

void PrintDrawingSheet ( const RENDER_SETTINGS aSettings,
const PAGE_INFO aPageInfo,
const wxString &  aSheetName,
const wxString &  aSheetPath,
const wxString &  aFileName,
const TITLE_BLOCK aTitleBlock,
const std::map< wxString, wxString > *  aProperties,
int  aSheetCount,
const wxString &  aPageNumber,
double  aScalar,
const PROJECT aProject,
const wxString &  aSheetLayer = wxEmptyString,
bool  aIsFirstPage = true 
)

Print the border and title block.

Parameters
aDCThe device context.
aPageInfofor margins and page size (in mils).
aSheetNameThe sheet name, for basic inscriptions.
aSheetPathThe sheetpath (full sheet name), for basic inscriptions.
aFileNameThe file name, for basic inscriptions.
aTitleBlockThe sheet title block, for text variable resolution.
aPropertiesOptional properties for text variable resolution.
aSheetCountThe number of sheets (for text variable resolution).
aPageNumberThe page number.
aScalarthe scale factor to convert from mils to internal units.
aSheetLayerThe layer from Pcbnew.
aIsFirstPageTrue when this is the first page. This only has meaning for schematics.

Parameters used in aPageInfo

  • the size of the drawing sheet.
  • the LTmargin The left top margin of the drawing sheet.
  • the RBmargin The right bottom margin of the drawing sheet.

Definition at line 1021 of file eda_draw_frame.cpp.

References DS_DRAW_ITEM_LIST::BuildDrawItemsList(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), DS_DRAW_ITEM_LIST::Print(), DS_DRAW_ITEM_LIST::SetDefaultPenSize(), DS_DRAW_ITEM_LIST::SetFileName(), DS_DRAW_ITEM_LIST::SetIsFirstPage(), DS_DRAW_ITEM_LIST::SetPageNumber(), DS_DRAW_ITEM_LIST::SetPlotterMilsToIUfactor(), DS_DRAW_ITEM_LIST::SetProject(), DS_DRAW_ITEM_LIST::SetProperties(), DS_DRAW_ITEM_LIST::SetSheetCount(), DS_DRAW_ITEM_LIST::SetSheetLayer(), DS_DRAW_ITEM_LIST::SetSheetName(), DS_DRAW_ITEM_LIST::SetSheetPath(), and unityScale.

Referenced by DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().