gui.symlink_dialog.SymlinkDialog Class Reference

Dialog for creating or editing a symlinks. More...

Inheritance diagram for gui.symlink_dialog.SymlinkDialog:

Public Member Functions
	__init__ (self, parent, set[DataPointPath] existing_paths, DataPointPath path=None, DataPointPath symlink_target=None)
	validate_and_accept (self)
	Validate the entered data point and symlink target paths, display an error for invalid input, and accept the dialog when all values are valid.
tuple[DataPointPath, DataPointPath]	get_values (self)
	Return the path and target values entered in the LineEdits.

Public Attributes
	existing_paths = existing_paths
	ui = Ui_SymlinkDialog()
	validate_and_accept
	reject

Protected Member Functions
	_show_error (self, str message)
	Display the given error message in the error label.
	_parse_path (self, str value, QLineEdit line_edit, str error_message)

Static Protected Member Functions
	_set_line_edit_error (QLineEdit line_edit)
	Highlight the line edit as invalid and give it focus.

Detailed Description

Dialog for creating or editing a symlinks.

The dialog allows the user to specify a path for the symbolic link and the target data point path it should reference. Existing paths are kept so that the dialog can validate the requested link path and prevent conflicts.

The dialog can be initialized with path and symlink target values. Field's of the form will then be prefilled with these provided values.

Constructor & Destructor Documentation

__init__()

gui.symlink_dialog.SymlinkDialog.__init__	(		self,
			parent,
		set[DataPointPath]	existing_paths,
		DataPointPath	path = None,
		DataPointPath	symlink_target = None )

Member Function Documentation

_parse_path()

gui.symlink_dialog.SymlinkDialog._parse_path ( self, str value, QLineEdit line_edit, str error_message )

protected

_set_line_edit_error()

gui.symlink_dialog.SymlinkDialog._set_line_edit_error ( QLineEdit line_edit )

staticprotected

Highlight the line edit as invalid and give it focus.

_show_error()

gui.symlink_dialog.SymlinkDialog._show_error ( self, str message )

protected

Display the given error message in the error label.

get_values()

tuple[DataPointPath, DataPointPath] gui.symlink_dialog.SymlinkDialog.get_values

(

self

)

Return the path and target values entered in the LineEdits.

validate_and_accept()

gui.symlink_dialog.SymlinkDialog.validate_and_accept

(

self

)

Validate the entered data point and symlink target paths, display an error for invalid input, and accept the dialog when all values are valid.

Member Data Documentation

existing_paths

gui.symlink_dialog.SymlinkDialog.existing_paths = existing_paths

reject

gui.symlink_dialog.SymlinkDialog.reject

ui

gui.symlink_dialog.SymlinkDialog.ui = Ui_SymlinkDialog()

validate_and_accept

gui.symlink_dialog.SymlinkDialog.validate_and_accept

---

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

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