Mach Modules Documentation
Lua Module API Documentation
Loading...
Searching...
No Matches
GUIModule.lua
Go to the documentation of this file.
1
9GUIModule.scrError.GetMsg();
15GUIModule.scrError.GetMsgCount();
43GUIModule.api_e(meta, api_func, ...);
48returns(excluding the error code);
56GUIModule.api(...);
71GUIModule.RunHooks(hook_name, ...);
77GUIModule.GetInstanceCount();
83GUIModule.IsScreenLoaded();
92GUIModule.GetCleanedLabel(object_name);
100GUIModule.ConvertToLegalVariableName(name);
108GUIModule.GetObjectNameCore(object_name);
116GUIModule.GetObjectPasswordLevelAsValue(object_name);
125GUIModule.GetObjectPasswordLevel(object_name);
133GUIModule.SetObjectPasswordLevel(object_name, level);
165SpecificScreenModule.SwitchSpecialMode(curr_mode, prev_mode, ...);
203SpecificScreenModule.SwitchSpecialMode(curr_mode, prev_mode, ctrl_name, ...);
270GUIModule.ScreenToggleButtonCall(handler, ctrl_name, event_source, ...);
298SpecificScreenModule.HandleActionButton1(direction, amount, ...);
332SpecificScreenModule.HandleActionButton1(direction, amount, ctrl_name, ...);
393GUIModule.ScreenButtonCall(handler, ctrl_name, event_source, ctrl_type, ...);
433ThisScreenModule.ModifyAxisDROPosition_Screen(dro_new_value, AxisID, ...);
511GUIModule.ScreenDROModify(handler, new_value, ctrl_name, event_source, ...);
535GUIModule.MachButtonCall(mach_func_name, control_name, event_source, ctrl_type, ...);
546GUIModule.ScreenTabEnter(...);
555GUIModule.ScreenTabExit(...);
564GUIModule.ScreenPageChanging(...);
572GUIModule.ScreenPageChanged(...);
584GUIModule.IsObject(name);
593GUIModule.DoesHaveProperty(name, datatype);
608GUIModule.SetHidden(name, dummy_unused, make_hidden);
622GUIModule.GetHidden(name, dummy_unused);
631GUIModule.ShowGroupInnards(group_name, show);
640GUIModule.FormatDRO(name, enabled);
656GUIModule.orig_SetObject(name, datatype, val, force);
663GUIModule.ObjectCacheClear();
674GUIModule.ObjectCache.FindObjects();
689GUIModule.SetObject(name, property, val, force);
700GUIModule.GetObject(name, datatype);
711GUIModule.GetDropDownSelectedIndex(name);
719GUIModule.SetDropDownSelectedIndex(name, idx);
728GUIModule.GetMMToggleButtonWidthPixel(name);
739GUIModule.SetMMToggleButton(name, value);
749GUIModule.GetMMToggleButton(name);
761GUIModule.SetAxisObject(name, datatype, val, axis);
770GUIModule.SetLED(name, val);
778GUIModule.GetLED(name);
790GUIModule.SetLabelLED(name, color, val);
799GUIModule.SetButtonLED(name, val, color);
808GUIModule.SetDRO(name, val);
816GUIModule.GetDRO(name);
823GUIModule.StartScrollDRO(name, val, minimum, maximum);
830GUIModule.StartScrollDRO();
837GUIModule.StopScrollDRO(name);
844GUIModule.StopScrollDRO();
856GUIModule.UpdateScrollDRO();
873GUIModule.PlusMinusDRO(name, val, startscrolling, minimum, maximum);
879GUIModule.DoFunctionName(Name);
887GUIModule.DoFunctionNameInst(inst, Name);
893GUIModule.DoFunctionCode(NumberCode);
905GUIModule.ScreenObject.Associate(btn_name);
912GUIModule.ScreenObject.UpdatePosition();
921GUIModule.ScreenObject.UpdateState();
925GUIModule.ScreenObject.GetState();
929GUIModule.ScreenObject.SetState();
938GUIModule.ScreenObject.UpdateScreen();
949GUIModule.AxisButton.Associate(btn_name, axis_id);
958GUIModule.AxisButton.UpdateState();
975GUIModule.StackableCollection.new(constraints, ...);
983GUIModule.StackableCollection.Log(...);
992GUIModule.StackableCollection.FitsHereP();
1004GUIModule.StackableCollection.NextPosition();
1018GUIModule.StackableCollection.Stack();
1028GUIModule.AncestorPath(obj_name);
1046GUIModule.LayoutObjects.new(grid_objects);
1055GUIModule.LayoutObjects.AddToRow(row_id);
1068GUIModule.LayoutObjects.Layout();
1076GUIModule.LayoutObjects.Hidden(value);
1083GUIModule.LayoutObjects.HideRow();
1090GUIModule.LayoutObjects.ShowRow();
1127GUIModule.WalkScreenObjectsDFS(obj_name, parent_first, filter_fn);
1139GUIModule.GetListOfChildren(Parent, AllowedTypes, NotAllowedTypes, NotAllowedNames);
1147MatchInTable(value, options);
1159GUIModule.BuildScreenTable(parent);
1167GUIModule.GetWholeScreenTable();
1176GUIModule.TranslateObject(obj);
1184GUIModule.TranslateGroup(obj);
1193GUIModule.Notebooks.Get();
1205GUIModule.Notebook.new();
1214GUIModule.Notebook.GetCurrentTab();
1221GUIModule.Notebook.IsOnCurrentPage();
1229GUIModule.Notebook.GetTabInfoFromLabel();
1240GUIModule.Notebooks.BuildMapping();
1248GUIModule.StartScreenLoadedCheck();
1257GUIModule.GetMachStateEnabledControls();
1264GUIModule.GetAllControls();
1276GUIModule.RefreshStateEnabledControls();
1284GUIModule.RefreshControl(obj_name);
1293GUIModule.RefreshAllControls(ctrl_type);
MatchInTable(value, options)
Check whether a value exists in a table of options.
returns(excluding the error code)
Call a screen API function without metadata, forwarding all arguments.
filter_fn(...)
Default filter function that accepts all screen objects.
name("m3")
Handle M3 plasma cutting start failure by reporting an alarm or error based on machine state.