Wiki

User Tools

Site Tools

Trace:
dev:v3:gui_api:dialog:inputgui2

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
dev:v3:gui_api:dialog:inputgui2 [2020/07/09 06:32] – created jedi18dev:v3:gui_api:dialog:inputgui2 [2020/07/09 12:41] (current) – jedi18
Line 24: Line 24:
 === Examples === === Examples ===
  
-  * <code lua> local coord1 = gui.CoordinateGUI("Coordinate1") </code>+  * <code lua> local coord1 = gui.Coordinate("Coordinate1") </code>
  
 ---- ----
Line 70: Line 70:
  
   * <code lua> coord1:addOnChangeCallback(function() message(tostring(coord1:value())) end) </code>   * <code lua> coord1:addOnChangeCallback(function() message(tostring(coord1:value())) end) </code>
 +
 +----
 +
 +===== Entity Picker GUI Class =====
 +
 +----
 +
 +[[https://github.com/LibreCAD/LibreCAD_3/blob/master/lcUI/widgets/guiAPI/entitygui.h|Github Link]]
 +<code cpp-qt> namespace lc::ui::api </code>
 +
 +The entity picker gui widget allows the user to select an entity by dragging their mouse and selecting the required entities which are then added to the entity list. Selecting an entity from the list highlights it in the cadmdichild so the user can see which entity it refers to.
 +
 +----
 +
 +==== Constructor ====
 +
 +----
 +
 +=== Description ===
 +
 +Constructs an Entity Picker GUI widget.
 +
 +=== Examples ===
 +
 +  * <code lua> local entity1 = gui.EntityPicker("Entity1") </code>
 +
 +----
 +
 +==== Get Values ====
 +
 +----
 +
 +=== Description ===
 +
 +Get a list of all the entity selected using the entity picker widget. It returns a list of cadentity shared pointers.
 +
 +=== Examples ===
 +
 +  * <code lua> local entities = entity1:value() </code>
 +
 +----
 +
 +==== Set Value ====
 +
 +----
 +
 +=== Description ===
 +
 +An entity list is passed in as a parameter and all these entities are added to the list (unless entity is already added to the list).
 +
 +=== Examples ===
 +
 +  * <code lua> entity1:setValue(entitiesList) </code>
 +
 +----
 +
 +==== Add Callback ====
 +
 +----
 +
 +=== Description ===
 +
 +Add callback for when an entity is selected in the entity list.
 +
 +=== Examples ===
 +
 +  * <code lua> entity1:addCallback(function(selectedEntity) message("An entity has been selected in the list") end) </code>
 +
 +----
 +
 +==== Add Entity ====
 +
 +----
 +
 +=== Description ===
 +
 +Add an entity to the entity list.
 +
 +=== Examples ===
 +
 +  * <code lua> entity1:addEntity(lineEntity) </code>
 +
 +----
 +
 +===== Number GUI Class =====
 +
 +----
 +
 +[[https://github.com/LibreCAD/LibreCAD_3/blob/master/lcUI/widgets/guiAPI/numbergui.h|Github Link]]
 +<code cpp-qt> namespace lc::ui::api </code>
 +
 +The number gui widget is used for entering a number (double).
 +
 +----
 +
 +==== Constructor ====
 +
 +----
 +
 +=== Description ===
 +
 +Constructs a Number GUI widget.
 +
 +=== Examples ===
 +
 +  * <code lua> local number1 = gui.Number("Number1") </code>
 +
 +----
 +
 +==== Get Values ====
 +
 +----
 +
 +=== Description ===
 +
 +Gets the value of the number widget.
 +
 +=== Examples ===
 +
 +  * <code lua> local val = number1:value() </code>
 +
 +----
 +
 +==== Set Value ====
 +
 +----
 +
 +=== Description ===
 +
 +Sets the number widget value.
 +
 +=== Examples ===
 +
 +  * <code lua> number1:setValue(2.4) </code>
 +
 +----
 +
 +==== Add Callback ====
 +
 +----
 +
 +=== Description ===
 +
 +Add callback for when the number is changed
 +
 +=== Examples ===
 +
 +  * <code lua> number1:addCallback(function(num) message(tostring(num)) end) </code>
 +
 +----
 +
 +===== Slider GUI Class =====
 +
 +----
 +
 +[[https://github.com/LibreCAD/LibreCAD_3/blob/master/lcUI/widgets/guiAPI/slidergui.h|Github Link]]
 +<code cpp-qt> namespace lc::ui::api </code>
 +
 +The slider gui widget is used for values that could use a slider input.
 +
 +----
 +
 +==== Constructor ====
 +
 +----
 +
 +=== Description ===
 +
 +Constructs a Slider GUI Widget.
 +
 +=== Examples ===
 +
 +  * <code lua> local slider1 = gui.Slider("Slider1") </code>
 +
 +----
 +
 +==== Get Values ====
 +
 +----
 +
 +=== Description ===
 +
 +Gets the value of the slider widget. Returns a //double// value.
 +
 +=== Examples ===
 +
 +  * <code lua> local val = slider1:value() </code>
 +
 +----
 +
 +==== Set Value ====
 +
 +----
 +
 +=== Description ===
 +
 +Sets the slider widget value. Expects a //double// parameter.
 +
 +=== Examples ===
 +
 +  * <code lua> slider1:setValue(2.4) </code>
 +
 +----
 +
 +==== Add Callback ====
 +
 +----
 +
 +=== Description ===
 +
 +Add callback for when the slider value is changed.
 +
 +=== Examples ===
 +
 +  * <code lua> slider1:addCallback(function(num) message(tostring(num)) end) </code>
  
 ---- ----
dev/v3/gui_api/dialog/inputgui2.1594276355.txt.gz · Last modified: 2020/07/09 06:32 by jedi18

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki