pcbnew.SETTINGS_MANAGER Class Reference

Inheritance diagram for pcbnew.SETTINGS_MANAGER:

Public Member Functions
	__init__ (self, aHeadless=False)
	IsOK (self)
	SetKiway (self, aKiway)
	Load (self, *args)
	Save (self, *args)
	FlushAndRelease (self, aSettings, aSave=True)
	ResetToDefaults (self)
	ClearFileHistory (self)
	GetColorSettings (self, aName)
	GetColorSettingsList (self)
	SaveColorSettings (self, *args)
	AddNewColorSettings (self, aFilename)
	GetMigratedColorSettings (self)
	GetCommonSettings (self)
	GetPathForSettingsFile (self, aSettings)
	MigrateIfNeeded (self)
	SetMigrationSource (self, aSource)
	SetMigrateLibraryTables (self, aMigrate=True)
	GetPreviousVersionPaths (self, aName=None)
	ReloadColorSettings (self)
	LoadProject (self, aFullPath, aSetActive=True)
	UnloadProject (self, aProject, aSave=True)
	IsProjectOpen (self)
	IsProjectOpenNotDummy (self)
	Prj (self)
	GetProject (self, aFullPath)
	GetOpenProjects (self)
	SaveProject (self, *args)
	SaveProjectAs (self, aFullPath, aProject=None)
	SaveProjectCopy (self, aFullPath, aProject=None)
	GetProjectBackupsPath (self)
	BackupProject (self, aReporter, aTarget)
	TriggerBackupIfNeeded (self, aReporter)

Static Public Member Functions
	IsSettingsPathValid (aPath)
	GetColorSettingsPath ()
	GetToolbarSettingsPath ()
	GetSettingsVersion ()
	GetUserSettingsPath ()

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 3778 of file pcbnew.py.

Constructor & Destructor Documentation

__init__()

pcbnew.SETTINGS_MANAGER.__init__	(		self,
			aHeadless = False )

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

Definition at line 3784 of file pcbnew.py.

Member Function Documentation

AddNewColorSettings()

pcbnew.SETTINGS_MANAGER.AddNewColorSettings	(		self,
			aFilename )

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

Definition at line 3835 of file pcbnew.py.

BackupProject()

pcbnew.SETTINGS_MANAGER.BackupProject	(		self,
			aReporter,
			aTarget )

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

Definition at line 3915 of file pcbnew.py.

ClearFileHistory()

pcbnew.SETTINGS_MANAGER.ClearFileHistory

(

self

)

ClearFileHistory(SETTINGS_MANAGER self)

Definition at line 3819 of file pcbnew.py.

FlushAndRelease()

pcbnew.SETTINGS_MANAGER.FlushAndRelease	(		self,
			aSettings,
			aSave = True )

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

Definition at line 3811 of file pcbnew.py.

GetColorSettings()

pcbnew.SETTINGS_MANAGER.GetColorSettings	(		self,
			aName )

GetColorSettings(SETTINGS_MANAGER self, wxString aName) -> COLOR_SETTINGS *

Definition at line 3823 of file pcbnew.py.

GetColorSettingsList()

pcbnew.SETTINGS_MANAGER.GetColorSettingsList

(

self

)

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

Definition at line 3827 of file pcbnew.py.

GetColorSettingsPath()

pcbnew.SETTINGS_MANAGER.GetColorSettingsPath ( )

static

GetColorSettingsPath() -> wxString

Definition at line 3929 of file pcbnew.py.

GetCommonSettings()

pcbnew.SETTINGS_MANAGER.GetCommonSettings

(

self

)

GetCommonSettings(SETTINGS_MANAGER self) -> COMMON_SETTINGS *

Definition at line 3843 of file pcbnew.py.

GetMigratedColorSettings()

pcbnew.SETTINGS_MANAGER.GetMigratedColorSettings

(

self

)

GetMigratedColorSettings(SETTINGS_MANAGER self) -> COLOR_SETTINGS *

Definition at line 3839 of file pcbnew.py.

GetOpenProjects()

pcbnew.SETTINGS_MANAGER.GetOpenProjects

(

self

)

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

Definition at line 3895 of file pcbnew.py.

GetPathForSettingsFile()

pcbnew.SETTINGS_MANAGER.GetPathForSettingsFile	(		self,
			aSettings )

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

Definition at line 3847 of file pcbnew.py.

GetPreviousVersionPaths()

pcbnew.SETTINGS_MANAGER.GetPreviousVersionPaths	(		self,
			aName = None )

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

Definition at line 3863 of file pcbnew.py.

GetProject()

pcbnew.SETTINGS_MANAGER.GetProject	(		self,
			aFullPath )

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

Definition at line 3891 of file pcbnew.py.

GetProjectBackupsPath()

pcbnew.SETTINGS_MANAGER.GetProjectBackupsPath

(

self

)

GetProjectBackupsPath(SETTINGS_MANAGER self) -> wxString

Definition at line 3911 of file pcbnew.py.

GetSettingsVersion()

pcbnew.SETTINGS_MANAGER.GetSettingsVersion ( )

static

GetSettingsVersion() -> string

Definition at line 3939 of file pcbnew.py.

GetToolbarSettingsPath()

pcbnew.SETTINGS_MANAGER.GetToolbarSettingsPath ( )

static

GetToolbarSettingsPath() -> wxString

Definition at line 3934 of file pcbnew.py.

GetUserSettingsPath()

pcbnew.SETTINGS_MANAGER.GetUserSettingsPath ( )

static

GetUserSettingsPath() -> wxString

Definition at line 3944 of file pcbnew.py.

IsOK()

pcbnew.SETTINGS_MANAGER.IsOK

(

self

)

IsOK(SETTINGS_MANAGER self) -> bool

Definition at line 3789 of file pcbnew.py.

IsProjectOpen()

pcbnew.SETTINGS_MANAGER.IsProjectOpen

(

self

)

IsProjectOpen(SETTINGS_MANAGER self) -> bool

Definition at line 3879 of file pcbnew.py.

IsProjectOpenNotDummy()

pcbnew.SETTINGS_MANAGER.IsProjectOpenNotDummy

(

self

)

IsProjectOpenNotDummy(SETTINGS_MANAGER self) -> bool

Definition at line 3883 of file pcbnew.py.

IsSettingsPathValid()

pcbnew.SETTINGS_MANAGER.IsSettingsPathValid ( aPath )

static

IsSettingsPathValid(wxString aPath) -> bool

Definition at line 3924 of file pcbnew.py.

Load()

pcbnew.SETTINGS_MANAGER.Load	(		self,
		*	args )

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

Definition at line 3797 of file pcbnew.py.

LoadProject()

pcbnew.SETTINGS_MANAGER.LoadProject	(		self,
			aFullPath,
			aSetActive = True )

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

Definition at line 3871 of file pcbnew.py.

MigrateIfNeeded()

pcbnew.SETTINGS_MANAGER.MigrateIfNeeded

(

self

)

MigrateIfNeeded(SETTINGS_MANAGER self) -> bool

Definition at line 3851 of file pcbnew.py.

Prj()

pcbnew.SETTINGS_MANAGER.Prj

(

self

)

Prj(SETTINGS_MANAGER self) -> PROJECT &

Definition at line 3887 of file pcbnew.py.

ReloadColorSettings()

pcbnew.SETTINGS_MANAGER.ReloadColorSettings

(

self

)

ReloadColorSettings(SETTINGS_MANAGER self)

Definition at line 3867 of file pcbnew.py.

ResetToDefaults()

pcbnew.SETTINGS_MANAGER.ResetToDefaults

(

self

)

ResetToDefaults(SETTINGS_MANAGER self)

Definition at line 3815 of file pcbnew.py.

Save()

pcbnew.SETTINGS_MANAGER.Save	(		self,
		*	args )

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

Definition at line 3804 of file pcbnew.py.

SaveColorSettings()

pcbnew.SETTINGS_MANAGER.SaveColorSettings	(		self,
		*	args )

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

Definition at line 3831 of file pcbnew.py.

SaveProject()

pcbnew.SETTINGS_MANAGER.SaveProject	(		self,
		*	args )

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

Definition at line 3899 of file pcbnew.py.

SaveProjectAs()

pcbnew.SETTINGS_MANAGER.SaveProjectAs	(		self,
			aFullPath,
			aProject = None )

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

Definition at line 3903 of file pcbnew.py.

SaveProjectCopy()

pcbnew.SETTINGS_MANAGER.SaveProjectCopy	(		self,
			aFullPath,
			aProject = None )

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

Definition at line 3907 of file pcbnew.py.

SetKiway()

pcbnew.SETTINGS_MANAGER.SetKiway	(		self,
			aKiway )

SetKiway(SETTINGS_MANAGER self, KIWAY * aKiway)

Definition at line 3793 of file pcbnew.py.

SetMigrateLibraryTables()

pcbnew.SETTINGS_MANAGER.SetMigrateLibraryTables	(		self,
			aMigrate = True )

SetMigrateLibraryTables(SETTINGS_MANAGER self, bool aMigrate=True)

Definition at line 3859 of file pcbnew.py.

SetMigrationSource()

pcbnew.SETTINGS_MANAGER.SetMigrationSource	(		self,
			aSource )

SetMigrationSource(SETTINGS_MANAGER self, wxString aSource)

Definition at line 3855 of file pcbnew.py.

TriggerBackupIfNeeded()

pcbnew.SETTINGS_MANAGER.TriggerBackupIfNeeded	(		self,
			aReporter )

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

Definition at line 3919 of file pcbnew.py.

UnloadProject()

pcbnew.SETTINGS_MANAGER.UnloadProject	(		self,
			aProject,
			aSave = True )

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

Definition at line 3875 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 3781 of file pcbnew.py.

---

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

• pcbnew.py