KiCad PCB EDA Suite
SCH_FIND_COLLECTOR_DATA Class Reference

Class SCH_FIND_COLLECTOR_DATA is used as a data container for the associated item found by the SCH_FIND_COLLECTOR object. More...

#include <sch_collectors.h>

Public Member Functions

 SCH_FIND_COLLECTOR_DATA (const wxPoint &aPosition=wxDefaultPosition, const wxString &aSheetPath=wxEmptyString, SCH_ITEM *aParent=NULL)
 
wxPoint GetPosition () const
 
wxString GetSheetPath () const
 
SCH_ITEMGetParent () const
 

Private Attributes

wxPoint m_position
 The position in drawing units of the found item. More...
 
wxString m_sheetPath
 The human readable sheet path. More...
 
SCH_ITEMm_parent
 The parent object if the item found is a child object. More...
 

Detailed Description

Class SCH_FIND_COLLECTOR_DATA is used as a data container for the associated item found by the SCH_FIND_COLLECTOR object.

Definition at line 194 of file sch_collectors.h.

Constructor & Destructor Documentation

SCH_FIND_COLLECTOR_DATA::SCH_FIND_COLLECTOR_DATA ( const wxPoint aPosition = wxDefaultPosition,
const wxString &  aSheetPath = wxEmptyString,
SCH_ITEM aParent = NULL 
)
inline

Definition at line 206 of file sch_collectors.h.

209  : m_position( aPosition )
210  , m_sheetPath( aSheetPath )
211  , m_parent( aParent )
212  { }
wxString m_sheetPath
The human readable sheet path.
wxPoint m_position
The position in drawing units of the found item.
SCH_ITEM * m_parent
The parent object if the item found is a child object.

Member Function Documentation

SCH_ITEM* SCH_FIND_COLLECTOR_DATA::GetParent ( ) const
inline

Definition at line 218 of file sch_collectors.h.

References m_parent.

Referenced by SCH_FIND_COLLECTOR::GetText(), and SCH_EDIT_FRAME::OnFindReplace().

218 { return m_parent; }
SCH_ITEM * m_parent
The parent object if the item found is a child object.
wxPoint SCH_FIND_COLLECTOR_DATA::GetPosition ( ) const
inline

Definition at line 214 of file sch_collectors.h.

References m_position.

Referenced by SCH_EDIT_FRAME::updateFindReplaceView().

214 { return m_position; }
wxPoint m_position
The position in drawing units of the found item.
wxString SCH_FIND_COLLECTOR_DATA::GetSheetPath ( ) const
inline

Definition at line 216 of file sch_collectors.h.

References m_sheetPath.

Referenced by SCH_FIND_COLLECTOR::GetText(), SCH_EDIT_FRAME::OnFindReplace(), and SCH_EDIT_FRAME::updateFindReplaceView().

216 { return m_sheetPath; }
wxString m_sheetPath
The human readable sheet path.

Member Data Documentation

SCH_ITEM* SCH_FIND_COLLECTOR_DATA::m_parent
private

The parent object if the item found is a child object.

Definition at line 203 of file sch_collectors.h.

Referenced by GetParent().

wxPoint SCH_FIND_COLLECTOR_DATA::m_position
private

The position in drawing units of the found item.

Definition at line 197 of file sch_collectors.h.

Referenced by GetPosition().

wxString SCH_FIND_COLLECTOR_DATA::m_sheetPath
private

The human readable sheet path.

See also
SCH_SHEET_PATH::PathHumanReadable() of the found item.

Definition at line 200 of file sch_collectors.h.

Referenced by GetSheetPath().


The documentation for this class was generated from the following file: