gui.metadata_edit.MetadataEdit Class Reference

Widget for editing a metadata dictionary presented as a table view. More...

Inheritance diagram for gui.metadata_edit.MetadataEdit:

Classes
class	_MetadataDelegate
	Item delegate providing custom editors for metadata table entries. More...

Public Member Functions
	__init__ (self, parent=None, *args, **kwargs)
	Initialise the MetadataEdit widget.
	on_addMetadataButton_clicked (self)
	Qt slot to add a new empty metadata entry when the "+" button is pressed.
	on_delMetadataButton_clicked (self)
	Qt slot to remove selected metadata entry when the "-" button is pressed.
	on_edit_error_occurred (self, int error_code)
	Qt slot called when an error occurs while editing a metadata entry.
	on_metadata_reset (self)
	Enable or disable metadata buttons based on current metadata.

Public Attributes
	model = MetadataModel()
	ui = Ui_MetadataEdit()
	on_edit_error_occurred
	on_metadata_reset

Detailed Description

Widget for editing a metadata dictionary presented as a table view.

Constructor & Destructor Documentation

__init__()

gui.metadata_edit.MetadataEdit.__init__	(		self,
			parent = None,
		*	args,
		**	kwargs )

Initialise the MetadataEdit widget.

Parameters

parent	The optional parent Qt widget object.
args	Additional positional arguments passed onto the base class.
kwargs	Additional keyword arguments passed onto the base class.

Member Function Documentation

on_addMetadataButton_clicked()

gui.metadata_edit.MetadataEdit.on_addMetadataButton_clicked

(

self

)

Qt slot to add a new empty metadata entry when the "+" button is pressed.

on_delMetadataButton_clicked()

gui.metadata_edit.MetadataEdit.on_delMetadataButton_clicked

(

self

)

Qt slot to remove selected metadata entry when the "-" button is pressed.

on_edit_error_occurred()

gui.metadata_edit.MetadataEdit.on_edit_error_occurred	(		self,
		int	error_code )

Qt slot called when an error occurs while editing a metadata entry.

Displays a warning message describing the edit error based on the provided error code.

Parameters

error_code

The error code identifying the type of edit failure.

on_metadata_reset()

gui.metadata_edit.MetadataEdit.on_metadata_reset

(

self

)

Enable or disable metadata buttons based on current metadata.

Metadata without type entry indicates a dangling symlink and cannot be modified.

Member Data Documentation

model

gui.metadata_edit.MetadataEdit.model = MetadataModel()

on_edit_error_occurred

gui.metadata_edit.MetadataEdit.on_edit_error_occurred

on_metadata_reset

gui.metadata_edit.MetadataEdit.on_metadata_reset

ui

gui.metadata_edit.MetadataEdit.ui = Ui_MetadataEdit()

---

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

• clients/configTool/src/rtctk/configtool/gui/metadata_edit.py