class documentation

class Constraint_Editor(QDialog2):

View In Hierarchy

Constraint_Editor class.
Method __init__ Prepares the constraint editor, but doesn't fully initialize it yet.
Method changed.setter Sets the "changed" state. This updates the window title.
Method get_constraints Gets the list of constraints.
Method on_table_cell_edited Gets called after a table cell has been edited.
Method on_table_row_added Gets called after a row has been added to the table.
Method on_table_row_deleted Gets called after a row has been deleted from the table.
Method reload Reloads the constraint editor.
Method showEvent Gets called when the dialog is opened.
Method update_table Populates the table.
Constant HTML Undocumented
Class Variable Constraint_Options Undocumented
Class Variable Constraint_Types Undocumented
Instance Variable changed Returns the "changed" state.
Instance Variable gui Undocumented
Instance Variable table Undocumented
Instance Variable text_browser Undocumented
Property rows Gets the list of rows (constraint groups).
Property rows_count Gets the number of rows (constraint groups).
Instance Variable _changed Undocumented
Instance Variable _constraint_collection Undocumented

Inherited from QDialog2:

Method show Shows this dialog.
Instance Variable user_accepted Undocumented

Inherited from QLayouted (via QDialog2):

Method addButtons Adds buttons.
Method addLayout Adds layout.
Method addSpacing Adds spacing.
Method addWidget Adds widget.
Method install_layout Installs this layout in the parent.
Instance Variable _layout Undocumented
def __init__(self, gui):
Prepares the constraint editor, but doesn't fully initialize it yet.
Parameters
gui:GUIGUI
@changed.setter
def changed(self, changed):
Sets the "changed" state. This updates the window title.
Parameters
changed:boolUndocumented
def get_constraints(self):
Gets the list of constraints.
Returns
List[Constraint]List of constraints
def on_table_cell_edited(self, value, row, column):
Gets called after a table cell has been edited.
Parameters
value:strCell value
row:intRow index
column:intColumn index
def on_table_row_added(self):
Gets called after a row has been added to the table.
def on_table_row_deleted(self, row):
Gets called after a row has been deleted from the table.
Parameters
row:intRow index
def reload(self):
Reloads the constraint editor.
def showEvent(self, event):
Gets called when the dialog is opened.
Parameters
event:QShowEventQShowEvent
def update_table(self):
Populates the table.
HTML =

Undocumented

Value
f"""
        Lengths in <b>cm</b>. &nbsp; Angles in <b>degrees</b>.<br><br>

        <b style="color: {Theme.MainColor};">Experimental Feature</b><br><br>

        By default, all sampling volume points have relative permeability µ<sub>
r</sub> = 1.<br>
...
Constraint_Options =

Undocumented

Constraint_Types: dict[str, str] =

Undocumented

@property
changed: bool =
Returns the "changed" state.
gui =

Undocumented

table =

Undocumented

text_browser =

Undocumented

@property
rows: List[Dict] =
Gets the list of rows (constraint groups).
@property
rows_count: int =
Gets the number of rows (constraint groups).
_changed =

Undocumented

_constraint_collection =

Undocumented