AddonManager.CommandAddonManager Class Reference

Public Member Functions
def	Activated (self)
def	add_addon_repo (self, addon_repo)
def	add_macro (self, macro)
def	apply_updates (self)
def	check_updates (self)
def	enable_updates (self, num)
def	executemacro (self)
def	get_icon (self, repo)
def	GetResources (self)
def	install (self, repos=None)
def	launch (self)
def	mark (self, repo)
def	mark_recompute (self, addon)
def	reject (self)
def	remove (self)
def	remove_readonly (self, func, path, _)
def	show (self, idx)
def	show_config (self)
def	show_information (self, label)
def	show_macro (self, idx)
def	show_progress_bar (self, state)
def	switchtab (self, idx)
def	update (self)
def	update_repos (self, repos)
def	update_status (self, soft=False)

Public Attributes
	addon_removed
	check_worker
	config
	dialog
	doUpdate
	firstmacro
	firsttime
	install_worker
	macro_repo_dir
	macro_worker
	macros
	repos
	show_worker
	showmacro_worker
	update_worker

Detailed Description

The main Addon Manager class and FreeCAD command

Member Function Documentation

Activated()

def AddonManager.CommandAddonManager.Activated

(

self

)

References AddonManager.CommandAddonManager.launch().

Referenced by draftguitools.gui_rectangles.Rectangle.finish(), draftguitools.gui_ellipses.Ellipse.finish(), draftguitools.gui_texts.Text.finish(), draftguitools.gui_polygons.Polygon.finish(), draftguitools.gui_arcs.Arc.finish(), draftguitools.gui_mirror.Mirror.finish(), draftguitools.gui_move.Move.finish(), draftguitools.gui_lines.Line.finish(), draftguitools.gui_splines.BSpline.finish(), draftguitools.gui_points.Point.finish(), draftguitools.gui_beziers.BezCurve.finish(), draftguitools.gui_shapestrings.ShapeString.finish(), draftguitools.gui_rotate.Rotate.finish(), draftguitools.gui_beziers.CubicBezCurve.finish(), and ArchPanel.CommandPanel.getPoint().

add_addon_repo()

def AddonManager.CommandAddonManager.add_addon_repo	(		self,
			addon_repo
	)

adds a workbench to the list

References RemoteDebugger.RemoteDebugger.dialog, Gui::Dialog::DlgParameterFind.dialog, Gui::Dialog::TaskTextureMapping.dialog, AddonManager.CommandAddonManager.dialog, Gui::Dialog::TaskTransform.dialog, AddonManager.CommandAddonManager.get_icon(), and AddonManager.CommandAddonManager.repos.

add_macro()

def AddonManager.CommandAddonManager.add_macro	(		self,
			macro
	)

adds a macro to the list

References RemoteDebugger.RemoteDebugger.dialog, Gui::Dialog::DlgParameterFind.dialog, Gui::Dialog::TaskTextureMapping.dialog, AddonManager.CommandAddonManager.dialog, Gui::Dialog::TaskTransform.dialog, and AddonManager.CommandAddonManager.macros.

apply_updates()

def AddonManager.CommandAddonManager.apply_updates

(

self

)

apply all available updates

References RemoteDebugger.RemoteDebugger.dialog, Gui::Dialog::DlgParameterFind.dialog, Gui::Dialog::TaskTextureMapping.dialog, AddonManager.CommandAddonManager.dialog, Gui::Dialog::TaskTransform.dialog, AddonManager.CommandAddonManager.doUpdate, and AddonManager.CommandAddonManager.install().

check_updates()

def AddonManager.CommandAddonManager.check_updates

(

self

)

References AddonManager.CommandAddonManager.check_worker, RemoteDebugger.RemoteDebugger.dialog, Gui::Dialog::DlgParameterFind.dialog, Gui::Dialog::TaskTextureMapping.dialog, AddonManager.CommandAddonManager.dialog, Gui::Dialog::TaskTransform.dialog, and AddonManager.CommandAddonManager.doUpdate.

enable_updates()

def AddonManager.CommandAddonManager.enable_updates	(		self,
			num
	)

enables the update button

References RemoteDebugger.RemoteDebugger.dialog, Gui::Dialog::DlgParameterFind.dialog, Gui::Dialog::TaskTextureMapping.dialog, AddonManager.CommandAddonManager.dialog, and Gui::Dialog::TaskTransform.dialog.

executemacro()

def AddonManager.CommandAddonManager.executemacro

(

self

)

executes a selected macro

References RemoteDebugger.RemoteDebugger.dialog, Gui::Dialog::DlgParameterFind.dialog, Gui::Dialog::TaskTextureMapping.dialog, AddonManager.CommandAddonManager.dialog, Gui::Dialog::TaskTransform.dialog, and AddonManager.CommandAddonManager.macros.

get_icon()

def AddonManager.CommandAddonManager.get_icon	(		self,
			repo
	)

returns an icon for a repo

Referenced by AddonManager.CommandAddonManager.add_addon_repo(), and AddonManager.CommandAddonManager.update_status().

GetResources()

def AddonManager.CommandAddonManager.GetResources

(

self

)

References AddonManager.QT_TRANSLATE_NOOP().

install()

def AddonManager.CommandAddonManager.install	(		self,
			repos = None
	)

installs a workbench or macro

References RemoteDebugger.RemoteDebugger.dialog, Gui::Dialog::DlgParameterFind.dialog, Gui::Dialog::TaskTextureMapping.dialog, AddonManager.CommandAddonManager.dialog, Gui::Dialog::TaskTransform.dialog, AddonManager.CommandAddonManager.install_worker, and AddonManager.CommandAddonManager.repos.

Referenced by AddonManager.CommandAddonManager.apply_updates().

launch()

def AddonManager.CommandAddonManager.launch

(

self

)

Shows the Addon Manager UI

Referenced by AddonManager.CommandAddonManager.Activated().

mark()

def AddonManager.CommandAddonManager.mark	(		self,
			repo
	)

mark a workbench as updatable

References RemoteDebugger.RemoteDebugger.dialog, Gui::Dialog::DlgParameterFind.dialog, Gui::Dialog::TaskTextureMapping.dialog, AddonManager.CommandAddonManager.dialog, Gui::Dialog::TaskTransform.dialog, and AddonManager.CommandAddonManager.doUpdate.

mark_recompute()

def AddonManager.CommandAddonManager.mark_recompute	(		self,
			addon
	)

marks an addon in the list as installed but needs recompute

References RemoteDebugger.RemoteDebugger.dialog, Gui::Dialog::DlgParameterFind.dialog, Gui::Dialog::TaskTextureMapping.dialog, AddonManager.CommandAddonManager.dialog, and Gui::Dialog::TaskTransform.dialog.

reject()

def AddonManager.CommandAddonManager.reject

(

self

)

called when the window has been closed

References AddonManager.CommandAddonManager.addon_removed, RemoteDebugger.RemoteDebugger.dialog, Gui::Dialog::DlgParameterFind.dialog, Gui::Dialog::TaskTextureMapping.dialog, AddonManager.CommandAddonManager.dialog, Gui::Dialog::TaskTransform.dialog, AddonManager.CommandAddonManager.install_worker, AddonManager.CommandAddonManager.macro_repo_dir, and AddonManager.CommandAddonManager.remove_readonly().

Referenced by drafttaskpanels.task_shapestring.ShapeStringTaskPanel.action().

remove()

def AddonManager.CommandAddonManager.remove

(

self

)

uninstalls a macro or workbench

References AddonManager.CommandAddonManager.addon_removed, RemoteDebugger.RemoteDebugger.dialog, Gui::Dialog::DlgParameterFind.dialog, Gui::Dialog::TaskTextureMapping.dialog, AddonManager.CommandAddonManager.dialog, Gui::Dialog::TaskTransform.dialog, AddonManager.CommandAddonManager.macros, AddonManager.CommandAddonManager.remove_readonly(), AddonManager.CommandAddonManager.repos, and AddonManager.CommandAddonManager.update_status().

remove_readonly()

def AddonManager.CommandAddonManager.remove_readonly	(		self,
			func,
			path,
			_
	)

Remove a read-only file.

Referenced by AddonManager.CommandAddonManager.reject(), and AddonManager.CommandAddonManager.remove().

show()

def AddonManager.CommandAddonManager.show	(		self,
			idx
	)

loads information of a given workbench

References RemoteDebugger.RemoteDebugger.dialog, Gui::Dialog::DlgParameterFind.dialog, Gui::Dialog::TaskTextureMapping.dialog, AddonManager.CommandAddonManager.dialog, Gui::Dialog::TaskTransform.dialog, AddonManager.CommandAddonManager.firsttime, AddonManager.CommandAddonManager.repos, and AddonManager.CommandAddonManager.show_worker.

Referenced by Mod.Show.mTempoVis.TempoVis.show_all_dependencies(), and Mod.Show.mTempoVis.TempoVis.show_all_dependent().

show_config()

def AddonManager.CommandAddonManager.show_config

(

self

)

shows the configuration dialog

show_information()

def AddonManager.CommandAddonManager.show_information	(		self,
			label
	)

shows text in the information pane

References RemoteDebugger.RemoteDebugger.dialog, Gui::Dialog::DlgParameterFind.dialog, Gui::Dialog::TaskTextureMapping.dialog, AddonManager.CommandAddonManager.dialog, and Gui::Dialog::TaskTransform.dialog.

show_macro()

def AddonManager.CommandAddonManager.show_macro	(		self,
			idx
	)

loads information of a given macro

References RemoteDebugger.RemoteDebugger.dialog, Gui::Dialog::DlgParameterFind.dialog, Gui::Dialog::TaskTextureMapping.dialog, AddonManager.CommandAddonManager.dialog, Gui::Dialog::TaskTransform.dialog, AddonManager.CommandAddonManager.firstmacro, AddonManager.CommandAddonManager.macros, and AddonManager.CommandAddonManager.showmacro_worker.

show_progress_bar()

def AddonManager.CommandAddonManager.show_progress_bar	(		self,
			state
	)

shows or hides the progress bar

References RemoteDebugger.RemoteDebugger.dialog, Gui::Dialog::DlgParameterFind.dialog, Gui::Dialog::TaskTextureMapping.dialog, AddonManager.CommandAddonManager.dialog, Gui::Dialog::TaskTransform.dialog, AddonManager.CommandAddonManager.firstmacro, and AddonManager.CommandAddonManager.firsttime.

switchtab()

def AddonManager.CommandAddonManager.switchtab	(		self,
			idx
	)

does what needs to be done when switching tabs

References RemoteDebugger.RemoteDebugger.dialog, Gui::Dialog::DlgParameterFind.dialog, Gui::Dialog::TaskTextureMapping.dialog, AddonManager.CommandAddonManager.dialog, Gui::Dialog::TaskTransform.dialog, and AddonManager.CommandAddonManager.macros.

update()

def AddonManager.CommandAddonManager.update

(

self

)

updates the list of workbenches

References RemoteDebugger.RemoteDebugger.dialog, Gui::Dialog::DlgParameterFind.dialog, Gui::Dialog::TaskTextureMapping.dialog, AddonManager.CommandAddonManager.dialog, Gui::Dialog::TaskTransform.dialog, and AddonManager.CommandAddonManager.repos.

Referenced by ArchAxis.AxisSystemTaskPanel.addElement(), ArchSectionPlane.SectionPlaneTaskPanel.addElement(), ArchComponent.ComponentTaskPanel.addElement(), DraftGui.FacebinderTaskPanel.addElement(), femtaskpanels.task_result_mechanical._TaskPanel.calculate(), Spreadsheet_legacy.SpreadsheetView.changeCell(), draftguitools.gui_edit.Edit.endEditing(), draftguitools.gui_trackers.boxTracker.height(), ArchAxis.CommandArchGrid.IsActive(), draftguitools.gui_trackers.rectangleTracker.p3(), Plot.Plot.plot(), Spreadsheet_legacy.SpreadsheetView.recompute(), ArchAxis.AxisSystemTaskPanel.removeElement(), ArchSectionPlane.SectionPlaneTaskPanel.removeElement(), ArchComponent.ComponentTaskPanel.removeElement(), DraftGui.FacebinderTaskPanel.removeElement(), draftguitools.gui_trackers.gridTracker.reset(), ArchNesting.Nester.run(), and draftguitools.gui_edit.Edit.update_object().

update_repos()

def AddonManager.CommandAddonManager.update_repos	(		self,
			repos
	)

this function allows threads to update the main list of workbenches

References AddonManager.CommandAddonManager.repos.

update_status()

def AddonManager.CommandAddonManager.update_status	(		self,
			soft = False
	)

Updates the list of workbenches/macros. If soft is true, items
are not recreated (and therefore display text isn't triggered)"

References RemoteDebugger.RemoteDebugger.dialog, Gui::Dialog::DlgParameterFind.dialog, Gui::Dialog::TaskTextureMapping.dialog, AddonManager.CommandAddonManager.dialog, Gui::Dialog::TaskTransform.dialog, AddonManager.CommandAddonManager.get_icon(), AddonManager.CommandAddonManager.macros, and AddonManager.CommandAddonManager.repos.

Referenced by AddonManager.CommandAddonManager.remove().

Member Data Documentation

addon_removed

AddonManager.CommandAddonManager.addon_removed

Referenced by AddonManager.CommandAddonManager.reject(), and AddonManager.CommandAddonManager.remove().

check_worker

AddonManager.CommandAddonManager.check_worker

Referenced by AddonManager.CommandAddonManager.check_updates().

config

AddonManager.CommandAddonManager.config

dialog

AddonManager.CommandAddonManager.dialog

Referenced by AddonManager.CommandAddonManager.add_addon_repo(), AddonManager.CommandAddonManager.add_macro(), AddonManager.CommandAddonManager.apply_updates(), AddonManager.CommandAddonManager.check_updates(), PathScripts.PathJobDlg.JobTemplateExport.checkUncheckTools(), PathScripts.PathToolBitGui.ToolBitSelector.createTool(), AddonManager.CommandAddonManager.enable_updates(), PathScripts.PathPost.DlgSelectPostProcessor.exec_(), PathScripts.PathJobDlg.JobCreate.exec_(), PathScripts.PathJobDlg.JobTemplateExport.exec_(), AddonManager.CommandAddonManager.executemacro(), PathScripts.PathJobDlg.JobTemplateExport.exportButton(), draftguitools.gui_texts.Text.finish(), PathScripts.PathJobDlg.JobCreate.getTemplate(), PathScripts.PathJobDlg.JobTemplateExport.includePostProcessing(), PathScripts.PathJobDlg.JobTemplateExport.includeSettingOperationDepths(), PathScripts.PathJobDlg.JobTemplateExport.includeSettingOperationHeights(), PathScripts.PathJobDlg.JobTemplateExport.includeSettingOpsSettings(), PathScripts.PathJobDlg.JobTemplateExport.includeSettings(), PathScripts.PathJobDlg.JobTemplateExport.includeSettingToolRapid(), PathScripts.PathJobDlg.JobTemplateExport.includeStock(), PathScripts.PathJobDlg.JobTemplateExport.includeStockExtent(), PathScripts.PathJobDlg.JobTemplateExport.includeStockPlacement(), PathScripts.PathJobDlg.JobTemplateExport.includeToolControllers(), AddonManager.CommandAddonManager.install(), AddonManager.CommandAddonManager.mark(), AddonManager.CommandAddonManager.mark_recompute(), AddonManager.CommandAddonManager.reject(), AddonManager.CommandAddonManager.remove(), ArchComponent.IfcEditorDelegate.setModelData(), PathScripts.PathJobDlg.JobCreate.setupModel(), PathScripts.PathJobDlg.JobCreate.setupTemplate(), PathScripts.PathJobDlg.JobCreate.setupTitle(), AddonManager.CommandAddonManager.show(), AddonManager.CommandAddonManager.show_information(), AddonManager.CommandAddonManager.show_macro(), AddonManager.CommandAddonManager.show_progress_bar(), AddonManager.CommandAddonManager.switchtab(), AddonManager.CommandAddonManager.update(), AddonManager.CommandAddonManager.update_status(), PathScripts.PathPost.DlgSelectPostProcessor.updateTooltip(), and PathScripts.PathJobDlg.JobTemplateExport.updateUI().

doUpdate

AddonManager.CommandAddonManager.doUpdate

Referenced by AddonManager.CommandAddonManager.apply_updates(), AddonManager.CommandAddonManager.check_updates(), and AddonManager.CommandAddonManager.mark().

firstmacro

AddonManager.CommandAddonManager.firstmacro

Referenced by AddonManager.CommandAddonManager.show_macro(), and AddonManager.CommandAddonManager.show_progress_bar().

firsttime

AddonManager.CommandAddonManager.firsttime

Referenced by AddonManager.CommandAddonManager.show(), and AddonManager.CommandAddonManager.show_progress_bar().

install_worker

AddonManager.CommandAddonManager.install_worker

Referenced by AddonManager.CommandAddonManager.install(), and AddonManager.CommandAddonManager.reject().

macro_repo_dir

AddonManager.CommandAddonManager.macro_repo_dir

Referenced by AddonManager.CommandAddonManager.reject().

macro_worker

AddonManager.CommandAddonManager.macro_worker

macros

AddonManager.CommandAddonManager.macros

Referenced by AddonManager.CommandAddonManager.add_macro(), AddonManager.CommandAddonManager.executemacro(), AddonManager.CommandAddonManager.remove(), addonmanager_workers.FillMacroListWorker.retrieve_macros_from_git(), addonmanager_workers.FillMacroListWorker.retrieve_macros_from_wiki(), addonmanager_workers.FillMacroListWorker.run(), AddonManager.CommandAddonManager.show_macro(), AddonManager.CommandAddonManager.switchtab(), and AddonManager.CommandAddonManager.update_status().

repos

AddonManager.CommandAddonManager.repos

Referenced by AddonManager.CommandAddonManager.add_addon_repo(), AddonManager.CommandAddonManager.install(), AddonManager.CommandAddonManager.remove(), addonmanager_workers.InfoWorker.run(), addonmanager_workers.ShowWorker.run(), addonmanager_workers.InstallWorker.run(), AddonManager.CommandAddonManager.show(), AddonManager.CommandAddonManager.update(), AddonManager.CommandAddonManager.update_repos(), and AddonManager.CommandAddonManager.update_status().

show_worker

AddonManager.CommandAddonManager.show_worker

Referenced by AddonManager.CommandAddonManager.show().

showmacro_worker

AddonManager.CommandAddonManager.showmacro_worker

Referenced by AddonManager.CommandAddonManager.show_macro().

update_worker

AddonManager.CommandAddonManager.update_worker

---

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

• src/Mod/AddonManager/AddonManager.py