Inheritance diagram for pcbnew.SETTINGS_MANAGER:

Public Member Functions
def	__init__ (self, "bool" aHeadless=False)

"bool"	IsOK (self)

"void"	SetKiway (self, "KIWAY *" aKiway)

"void"	Load (self, *args)

"void"	Save (self, *args)

"void"	FlushAndRelease (self, "JSON_SETTINGS *" aSettings, "bool" aSave=True)

"COLOR_SETTINGS *"	GetColorSettings (self, *args)

"std::vector< COLOR_SETTINGS ,std::allocator< COLOR_SETTINGS > >"	GetColorSettingsList (self)

"void"	SaveColorSettings (self, *args)

"COLOR_SETTINGS *"	AddNewColorSettings (self, "wxString" aFilename)

"COLOR_SETTINGS *"	GetMigratedColorSettings (self)

"COMMON_SETTINGS *"	GetCommonSettings (self)

"wxString"	GetPathForSettingsFile (self, "JSON_SETTINGS *" aSettings)

"bool"	MigrateIfNeeded (self)

"void"	SetMigrationSource (self, "wxString" aSource)

"void"	SetMigrateLibraryTables (self, "bool" aMigrate=True)

"bool"	GetPreviousVersionPaths (self, "std::vector< wxString,std::allocator< wxString > > *" aName=None)

"void"	ReloadColorSettings (self)

"bool"	LoadProject (self, "wxString" aFullPath, "bool" aSetActive=True)

"bool"	UnloadProject (self, "PROJECT *" aProject, "bool" aSave=True)

"bool"	IsProjectOpen (self)

"PROJECT &"	Prj (self)

"PROJECT *"	GetProject (self, "wxString" aFullPath)

"std::vector< wxString,std::allocator< wxString > >"	GetOpenProjects (self)

"bool"	SaveProject (self, *args)

"void"	SaveProjectAs (self, "wxString" aFullPath, "PROJECT *" aProject=None)

"void"	SaveProjectCopy (self, "wxString" aFullPath, "PROJECT *" aProject=None)

"wxString"	GetProjectBackupsPath (self)

"bool"	BackupProject (self, "REPORTER &" aReporter)

"bool"	TriggerBackupIfNeeded (self, "REPORTER &" aReporter)

Static Public Member Functions
"bool"	IsSettingsPathValid ("wxString" aPath)

"wxString"	GetColorSettingsPath ()

"wxString"	GetUserSettingsPath ()

"std::string"	GetSettingsVersion ()

Properties
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Detailed Description

Proxy of C++ SETTINGS_MANAGER class.

Definition at line 2876 of file pcbnew.py.

Constructor & Destructor Documentation

◆ init()

def pcbnew.SETTINGS_MANAGER.__init__	(		self,
		"bool"	aHeadless = `False`
	)

__init__(SETTINGS_MANAGER self, bool aHeadless=False) -> SETTINGS_MANAGER

Definition at line 2882 of file pcbnew.py.

Member Function Documentation

◆ AddNewColorSettings()

"COLOR_SETTINGS *" pcbnew.SETTINGS_MANAGER.AddNewColorSettings	(		self,
		"wxString"	aFilename
	)

AddNewColorSettings(SETTINGS_MANAGER self, wxString aFilename) -> COLOR_SETTINGS *

Definition at line 2925 of file pcbnew.py.

◆ BackupProject()

"bool" pcbnew.SETTINGS_MANAGER.BackupProject	(		self,
		"REPORTER &"	aReporter
	)

BackupProject(SETTINGS_MANAGER self, REPORTER & aReporter) -> bool

Definition at line 3001 of file pcbnew.py.

◆ FlushAndRelease()

"void" pcbnew.SETTINGS_MANAGER.FlushAndRelease	(		self,
		"JSON_SETTINGS *"	aSettings,
		"bool"	aSave = `True`
	)

FlushAndRelease(SETTINGS_MANAGER self, JSON_SETTINGS * aSettings, bool aSave=True)

Definition at line 2909 of file pcbnew.py.

◆ GetColorSettings()

"COLOR_SETTINGS *" pcbnew.SETTINGS_MANAGER.GetColorSettings	(		self,
		*	args
	)

GetColorSettings(SETTINGS_MANAGER self, wxString aName="user") -> COLOR_SETTINGS

Definition at line 2913 of file pcbnew.py.

◆ GetColorSettingsList()

"std.vector< COLOR_SETTINGS *,std.allocator< COLOR_SETTINGS * > >" pcbnew.SETTINGS_MANAGER.GetColorSettingsList ( self )

GetColorSettingsList(SETTINGS_MANAGER self) -> std::vector< COLOR_SETTINGS *,std::allocator< COLOR_SETTINGS * > >

Definition at line 2917 of file pcbnew.py.

◆ GetColorSettingsPath()

"wxString" pcbnew.SETTINGS_MANAGER.GetColorSettingsPath ( )

static

GetColorSettingsPath() -> wxString

Definition at line 3015 of file pcbnew.py.

◆ GetCommonSettings()

"COMMON_SETTINGS *" pcbnew.SETTINGS_MANAGER.GetCommonSettings ( self )

GetCommonSettings(SETTINGS_MANAGER self) -> COMMON_SETTINGS *

Definition at line 2933 of file pcbnew.py.

◆ GetMigratedColorSettings()

"COLOR_SETTINGS *" pcbnew.SETTINGS_MANAGER.GetMigratedColorSettings ( self )

GetMigratedColorSettings(SETTINGS_MANAGER self) -> COLOR_SETTINGS *

Definition at line 2929 of file pcbnew.py.

◆ GetOpenProjects()

"std.vector< wxString,std.allocator< wxString > >" pcbnew.SETTINGS_MANAGER.GetOpenProjects ( self )

GetOpenProjects(SETTINGS_MANAGER self) -> std::vector< wxString,std::allocator< wxString > >

Definition at line 2981 of file pcbnew.py.

◆ GetPathForSettingsFile()

"wxString" pcbnew.SETTINGS_MANAGER.GetPathForSettingsFile	(		self,
		"JSON_SETTINGS *"	aSettings
	)

GetPathForSettingsFile(SETTINGS_MANAGER self, JSON_SETTINGS * aSettings) -> wxString

Definition at line 2937 of file pcbnew.py.

◆ GetPreviousVersionPaths()

"bool" pcbnew.SETTINGS_MANAGER.GetPreviousVersionPaths	(		self,
		"std::vector< wxString,std::allocator< wxString > > *"	aName = `None`
	)

GetPreviousVersionPaths(SETTINGS_MANAGER self, std::vector< wxString,std::allocator< wxString > > * aName=None) -> bool

Definition at line 2953 of file pcbnew.py.

◆ GetProject()

"PROJECT *" pcbnew.SETTINGS_MANAGER.GetProject	(		self,
		"wxString"	aFullPath
	)

GetProject(SETTINGS_MANAGER self, wxString aFullPath) -> PROJECT *

Definition at line 2977 of file pcbnew.py.

◆ GetProjectBackupsPath()

"wxString" pcbnew.SETTINGS_MANAGER.GetProjectBackupsPath ( self )

GetProjectBackupsPath(SETTINGS_MANAGER self) -> wxString

Definition at line 2997 of file pcbnew.py.

◆ GetSettingsVersion()

"std.string" pcbnew.SETTINGS_MANAGER.GetSettingsVersion ( )

static

GetSettingsVersion() -> string

Definition at line 3025 of file pcbnew.py.

◆ GetUserSettingsPath()

"wxString" pcbnew.SETTINGS_MANAGER.GetUserSettingsPath ( )

static

GetUserSettingsPath() -> wxString

Definition at line 3020 of file pcbnew.py.

Here is the caller graph for this function:

◆ IsOK()

"bool" pcbnew.SETTINGS_MANAGER.IsOK ( self )

IsOK(SETTINGS_MANAGER self) -> bool

Definition at line 2887 of file pcbnew.py.

◆ IsProjectOpen()

"bool" pcbnew.SETTINGS_MANAGER.IsProjectOpen ( self )

IsProjectOpen(SETTINGS_MANAGER self) -> bool

Definition at line 2969 of file pcbnew.py.

◆ IsSettingsPathValid()

"bool" pcbnew.SETTINGS_MANAGER.IsSettingsPathValid ( "wxString" aPath )

static

IsSettingsPathValid(wxString aPath) -> bool

Definition at line 3010 of file pcbnew.py.

◆ Load()

"void" pcbnew.SETTINGS_MANAGER.Load	(		self,
		*	args
	)

    Load(SETTINGS_MANAGER self)
    Load(SETTINGS_MANAGER self, JSON_SETTINGS * aSettings)

Definition at line 2895 of file pcbnew.py.

Here is the caller graph for this function:

◆ LoadProject()

"bool" pcbnew.SETTINGS_MANAGER.LoadProject	(		self,
		"wxString"	aFullPath,
		"bool"	aSetActive = `True`
	)

LoadProject(SETTINGS_MANAGER self, wxString aFullPath, bool aSetActive=True) -> bool

Definition at line 2961 of file pcbnew.py.

◆ MigrateIfNeeded()

"bool" pcbnew.SETTINGS_MANAGER.MigrateIfNeeded ( self )

MigrateIfNeeded(SETTINGS_MANAGER self) -> bool

Definition at line 2941 of file pcbnew.py.

◆ Prj()

"PROJECT &" pcbnew.SETTINGS_MANAGER.Prj ( self )

Prj(SETTINGS_MANAGER self) -> PROJECT &

Definition at line 2973 of file pcbnew.py.

◆ ReloadColorSettings()

"void" pcbnew.SETTINGS_MANAGER.ReloadColorSettings ( self )

ReloadColorSettings(SETTINGS_MANAGER self)

Definition at line 2957 of file pcbnew.py.

◆ Save()

"void" pcbnew.SETTINGS_MANAGER.Save	(		self,
		*	args
	)

    Save(SETTINGS_MANAGER self)
    Save(SETTINGS_MANAGER self, JSON_SETTINGS * aSettings)

Definition at line 2902 of file pcbnew.py.

Here is the caller graph for this function:

◆ SaveColorSettings()

"void" pcbnew.SETTINGS_MANAGER.SaveColorSettings	(		self,
		*	args
	)

SaveColorSettings(SETTINGS_MANAGER self, COLOR_SETTINGS * aSettings, string aNamespace="")

Definition at line 2921 of file pcbnew.py.

◆ SaveProject()

"bool" pcbnew.SETTINGS_MANAGER.SaveProject	(		self,
		*	args
	)

SaveProject(SETTINGS_MANAGER self, wxString aFullPath=wxEmptyString, PROJECT * aProject=None) -> bool

Definition at line 2985 of file pcbnew.py.

◆ SaveProjectAs()

"void" pcbnew.SETTINGS_MANAGER.SaveProjectAs	(		self,
		"wxString"	aFullPath,
		"PROJECT *"	aProject = `None`
	)

SaveProjectAs(SETTINGS_MANAGER self, wxString aFullPath, PROJECT * aProject=None)

Definition at line 2989 of file pcbnew.py.

◆ SaveProjectCopy()

"void" pcbnew.SETTINGS_MANAGER.SaveProjectCopy	(		self,
		"wxString"	aFullPath,
		"PROJECT *"	aProject = `None`
	)

SaveProjectCopy(SETTINGS_MANAGER self, wxString aFullPath, PROJECT * aProject=None)

Definition at line 2993 of file pcbnew.py.

◆ SetKiway()

"void" pcbnew.SETTINGS_MANAGER.SetKiway	(		self,
		"KIWAY *"	aKiway
	)

SetKiway(SETTINGS_MANAGER self, KIWAY * aKiway)

Definition at line 2891 of file pcbnew.py.

◆ SetMigrateLibraryTables()

"void" pcbnew.SETTINGS_MANAGER.SetMigrateLibraryTables	(		self,
		"bool"	aMigrate = `True`
	)

SetMigrateLibraryTables(SETTINGS_MANAGER self, bool aMigrate=True)

Definition at line 2949 of file pcbnew.py.

◆ SetMigrationSource()

"void" pcbnew.SETTINGS_MANAGER.SetMigrationSource	(		self,
		"wxString"	aSource
	)

SetMigrationSource(SETTINGS_MANAGER self, wxString aSource)

Definition at line 2945 of file pcbnew.py.

◆ TriggerBackupIfNeeded()

"bool" pcbnew.SETTINGS_MANAGER.TriggerBackupIfNeeded	(		self,
		"REPORTER &"	aReporter
	)

TriggerBackupIfNeeded(SETTINGS_MANAGER self, REPORTER & aReporter) -> bool

Definition at line 3005 of file pcbnew.py.

◆ UnloadProject()

"bool" pcbnew.SETTINGS_MANAGER.UnloadProject	(		self,
		"PROJECT *"	aProject,
		"bool"	aSave = `True`
	)

UnloadProject(SETTINGS_MANAGER self, PROJECT * aProject, bool aSave=True) -> bool

Definition at line 2965 of file pcbnew.py.

Property Documentation

◆ thisown

pcbnew.SETTINGS_MANAGER.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static

Definition at line 2879 of file pcbnew.py.

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

pcbnew.py

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ AddNewColorSettings()

◆ BackupProject()

◆ FlushAndRelease()

◆ GetColorSettings()

◆ GetColorSettingsList()

◆ GetColorSettingsPath()

◆ GetCommonSettings()

◆ GetMigratedColorSettings()

◆ GetOpenProjects()

◆ GetPathForSettingsFile()

◆ GetPreviousVersionPaths()

◆ GetProject()

◆ GetProjectBackupsPath()

◆ GetSettingsVersion()

◆ GetUserSettingsPath()

◆ IsOK()

◆ IsProjectOpen()

◆ IsSettingsPathValid()

◆ Load()

◆ LoadProject()

◆ MigrateIfNeeded()

◆ Prj()

◆ ReloadColorSettings()

◆ Save()

◆ SaveColorSettings()

◆ SaveProject()

◆ SaveProjectAs()

◆ SaveProjectCopy()

◆ SetKiway()

◆ SetMigrateLibraryTables()

◆ SetMigrationSource()

◆ TriggerBackupIfNeeded()

◆ UnloadProject()

Property Documentation

◆ thisown

◆ init()