KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
SYMBOL_EDIT_FRAME_CONTEXT Class Reference
Inheritance diagram for SYMBOL_EDIT_FRAME_CONTEXT:
SYMBOL_EDITOR_CONTEXT

Public Member Functions

 SYMBOL_EDIT_FRAME_CONTEXT (SYMBOL_EDIT_FRAME *aFrame)
 
LIB_SYMBOL * GetCurSymbol () const override
 
SCH_SCREEN * GetScreen () const override
 
LIB_ID GetLoadedLibId () const override
 
bool IsContentModified () const override
 
void SetContentModified (bool aModified=true) override
 
PROJECT & Prj () const override
 
TOOL_MANAGER * GetToolManager () const override
 
KIWAY * GetKiway () const override
 
bool CanAcceptApiCommands () const override
 
bool SaveSymbol () override
 Save the current symbol to its library, without any user interaction.
 
bool SaveSymbolCopy (const wxString &aFileName, bool aOverwrite) override
 Save a copy of the current symbol to the given library file, without user interaction.
 
bool RevertSymbol () override
 Reload the current symbol from its library, discarding unsaved changes.
 
bool LoadSymbol (const LIB_ID &aLibId) override
 Load a symbol into the editor (activating it for editing); false if not found.
 

Private Attributes

SYMBOL_EDIT_FRAME * m_frame
 

Detailed Description

Definition at line 36 of file symbol_editor_context.cpp.

Constructor & Destructor Documentation

◆ SYMBOL_EDIT_FRAME_CONTEXT()

SYMBOL_EDIT_FRAME_CONTEXT::SYMBOL_EDIT_FRAME_CONTEXT ( SYMBOL_EDIT_FRAME * aFrame)
inlineexplicit

Definition at line 39 of file symbol_editor_context.cpp.

References m_frame.

Member Function Documentation

◆ CanAcceptApiCommands()

bool SYMBOL_EDIT_FRAME_CONTEXT::CanAcceptApiCommands ( ) const
inlineoverridevirtual

Implements SYMBOL_EDITOR_CONTEXT.

Definition at line 66 of file symbol_editor_context.cpp.

References m_frame.

◆ GetCurSymbol()

LIB_SYMBOL * SYMBOL_EDIT_FRAME_CONTEXT::GetCurSymbol ( ) const
inlineoverridevirtual

Implements SYMBOL_EDITOR_CONTEXT.

Definition at line 41 of file symbol_editor_context.cpp.

References m_frame.

◆ GetKiway()

KIWAY * SYMBOL_EDIT_FRAME_CONTEXT::GetKiway ( ) const
inlineoverridevirtual

Implements SYMBOL_EDITOR_CONTEXT.

Definition at line 64 of file symbol_editor_context.cpp.

References m_frame.

◆ GetLoadedLibId()

LIB_ID SYMBOL_EDIT_FRAME_CONTEXT::GetLoadedLibId ( ) const
inlineoverridevirtual

Implements SYMBOL_EDITOR_CONTEXT.

Definition at line 45 of file symbol_editor_context.cpp.

References m_frame.

◆ GetScreen()

SCH_SCREEN * SYMBOL_EDIT_FRAME_CONTEXT::GetScreen ( ) const
inlineoverridevirtual

Implements SYMBOL_EDITOR_CONTEXT.

Definition at line 43 of file symbol_editor_context.cpp.

References m_frame.

◆ GetToolManager()

TOOL_MANAGER * SYMBOL_EDIT_FRAME_CONTEXT::GetToolManager ( ) const
inlineoverridevirtual

Implements SYMBOL_EDITOR_CONTEXT.

Definition at line 62 of file symbol_editor_context.cpp.

References m_frame.

◆ IsContentModified()

bool SYMBOL_EDIT_FRAME_CONTEXT::IsContentModified ( ) const
inlineoverridevirtual

Implements SYMBOL_EDITOR_CONTEXT.

Definition at line 53 of file symbol_editor_context.cpp.

References m_frame.

◆ LoadSymbol()

bool SYMBOL_EDIT_FRAME_CONTEXT::LoadSymbol ( const LIB_ID & aLibId)
inlineoverridevirtual

Load a symbol into the editor (activating it for editing); false if not found.

Implements SYMBOL_EDITOR_CONTEXT.

Definition at line 119 of file symbol_editor_context.cpp.

References m_frame.

◆ Prj()

PROJECT & SYMBOL_EDIT_FRAME_CONTEXT::Prj ( ) const
inlineoverridevirtual

Implements SYMBOL_EDITOR_CONTEXT.

Definition at line 60 of file symbol_editor_context.cpp.

References m_frame.

◆ RevertSymbol()

bool SYMBOL_EDIT_FRAME_CONTEXT::RevertSymbol ( )
inlineoverridevirtual

Reload the current symbol from its library, discarding unsaved changes.

Implements SYMBOL_EDITOR_CONTEXT.

Definition at line 98 of file symbol_editor_context.cpp.

References UTF8::empty(), LIB_SYMBOL::GetLibId(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), m_frame, and SYMBOL_LIBRARY_MANAGER::SymbolExists().

◆ SaveSymbol()

bool SYMBOL_EDIT_FRAME_CONTEXT::SaveSymbol ( )
inlineoverridevirtual

Save the current symbol to its library, without any user interaction.

Returns
false if there is no symbol, the library is read-only, or the save failed

Implements SYMBOL_EDITOR_CONTEXT.

Definition at line 68 of file symbol_editor_context.cpp.

References LIB_SYMBOL::GetLibId(), LIB_ID::GetLibNickname(), SYMBOL_LIBRARY_MANAGER::IsLibraryReadOnly(), and m_frame.

◆ SaveSymbolCopy()

bool SYMBOL_EDIT_FRAME_CONTEXT::SaveSymbolCopy ( const wxString & aFileName,
bool aOverwrite )
inlineoverridevirtual

Save a copy of the current symbol to the given library file, without user interaction.

Implements SYMBOL_EDITOR_CONTEXT.

Definition at line 88 of file symbol_editor_context.cpp.

References m_frame, and SaveSymbolCopyToFile().

◆ SetContentModified()

void SYMBOL_EDIT_FRAME_CONTEXT::SetContentModified ( bool aModified = true)
inlineoverridevirtual

Implements SYMBOL_EDITOR_CONTEXT.

Definition at line 55 of file symbol_editor_context.cpp.

References m_frame.

Member Data Documentation

◆ m_frame

SYMBOL_EDIT_FRAME* SYMBOL_EDIT_FRAME_CONTEXT::m_frame
private

Definition at line 125 of file symbol_editor_context.cpp.

Referenced by CanAcceptApiCommands(), GetCurSymbol(), GetKiway(), GetLoadedLibId(), GetScreen(), GetToolManager(), IsContentModified(), LoadSymbol(), Prj(), RevertSymbol(), SaveSymbol(), SaveSymbolCopy(), SetContentModified(), and SYMBOL_EDIT_FRAME_CONTEXT().

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