KiCad PCB EDA Suite
Loading...
Searching...
No Matches
FILEDLG_HOOK_RELATIVE_PATH Class Reference

Add a sticky "Use relative path" checkbox to a file dialog. More...

#include <filedlg_hook_relative_path.h>

Inheritance diagram for FILEDLG_HOOK_RELATIVE_PATH:

Public Member Functions

 FILEDLG_HOOK_RELATIVE_PATH (RELATIVE_PATH_CONTEXT aContext, wxFileDialogCustomizeHook *aChained=nullptr)
 
virtual void AddCustomControls (wxFileDialogCustomize &customizer) override
 
virtual void UpdateCustomControls () override
 
virtual void TransferDataFromCustomControls () override
 
bool GetUseRelativePath () const
 

Private Member Functions

 wxDECLARE_NO_COPY_CLASS (FILEDLG_HOOK_RELATIVE_PATH)
 

Static Private Member Functions

static bool & choiceRef (COMMON_SETTINGS *aCfg, RELATIVE_PATH_CONTEXT aContext)
 

Private Attributes

RELATIVE_PATH_CONTEXT m_context
 
wxFileDialogCustomizeHook * m_chained
 
bool m_relative = false
 
wxFileDialogCheckBox * m_cb = nullptr
 

Detailed Description

Add a sticky "Use relative path" checkbox to a file dialog.

wxFileDialog accepts a single customize hook, so another hook such as FILEDLG_HOOK_EMBED_FILE can be chained in to share the dialog.

Definition at line 42 of file filedlg_hook_relative_path.h.

Constructor & Destructor Documentation

◆ FILEDLG_HOOK_RELATIVE_PATH()

FILEDLG_HOOK_RELATIVE_PATH::FILEDLG_HOOK_RELATIVE_PATH ( RELATIVE_PATH_CONTEXT aContext,
wxFileDialogCustomizeHook * aChained = nullptr )
inline

Definition at line 45 of file filedlg_hook_relative_path.h.

References choiceRef(), m_chained, m_context, m_relative, and Pgm().

Referenced by wxDECLARE_NO_COPY_CLASS().

Member Function Documentation

◆ AddCustomControls()

virtual void FILEDLG_HOOK_RELATIVE_PATH::AddCustomControls ( wxFileDialogCustomize & customizer)
inlineoverridevirtual

Definition at line 53 of file filedlg_hook_relative_path.h.

References _, m_cb, m_chained, and m_relative.

◆ choiceRef()

◆ GetUseRelativePath()

bool FILEDLG_HOOK_RELATIVE_PATH::GetUseRelativePath ( ) const
inline

◆ TransferDataFromCustomControls()

virtual void FILEDLG_HOOK_RELATIVE_PATH::TransferDataFromCustomControls ( )
inlineoverridevirtual

Definition at line 76 of file filedlg_hook_relative_path.h.

References choiceRef(), m_cb, m_chained, m_context, m_relative, and Pgm().

◆ UpdateCustomControls()

virtual void FILEDLG_HOOK_RELATIVE_PATH::UpdateCustomControls ( )
inlineoverridevirtual

Definition at line 70 of file filedlg_hook_relative_path.h.

References m_chained.

◆ wxDECLARE_NO_COPY_CLASS()

FILEDLG_HOOK_RELATIVE_PATH::wxDECLARE_NO_COPY_CLASS ( FILEDLG_HOOK_RELATIVE_PATH )
private

Member Data Documentation

◆ m_cb

wxFileDialogCheckBox* FILEDLG_HOOK_RELATIVE_PATH::m_cb = nullptr
private

◆ m_chained

wxFileDialogCustomizeHook* FILEDLG_HOOK_RELATIVE_PATH::m_chained
private

◆ m_context

RELATIVE_PATH_CONTEXT FILEDLG_HOOK_RELATIVE_PATH::m_context
private

◆ m_relative

bool FILEDLG_HOOK_RELATIVE_PATH::m_relative = false
private

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