From 47a4706a14fb3d6a70cd31a3c6b16825de44ff18 Mon Sep 17 00:00:00 2001 From: Robert Jelic <36573031+NoryiE@users.noreply.github.com> Date: Thu, 18 May 2023 13:02:04 +0200 Subject: [PATCH] Updated Container docs updated docs for container (child instead of object) --- docs/objects/Container.md | 13 ++++++----- .../Container/{addObject.md => addChild.md} | 2 +- ...eFocusedObject.md => clearFocusedChild.md} | 8 +++---- .../Container/{getObject.md => getChild.md} | 4 ++-- .../{getDeepObject.md => getDeepChild.md} | 4 ++-- .../{removeObject.md => removeChild.md} | 4 ++-- docs/objects/Container/removeChildren.md | 22 +++++++++++++++++++ ...setFocusedObject.md => setFocusedChild.md} | 0 8 files changed, 40 insertions(+), 17 deletions(-) rename docs/objects/Container/{addObject.md => addChild.md} (91%) rename docs/objects/Container/{removeFocusedObject.md => clearFocusedChild.md} (68%) rename docs/objects/Container/{getObject.md => getChild.md} (88%) rename docs/objects/Container/{getDeepObject.md => getDeepChild.md} (90%) rename docs/objects/Container/{removeObject.md => removeChild.md} (90%) create mode 100644 docs/objects/Container/removeChildren.md rename docs/objects/Container/{setFocusedObject.md => setFocusedChild.md} (100%) diff --git a/docs/objects/Container.md b/docs/objects/Container.md index 804230f..1e2652b 100644 --- a/docs/objects/Container.md +++ b/docs/objects/Container.md @@ -4,14 +4,15 @@ In addition to the Object and VisualObject methods, container objects have the f | | | |---|---| -|[addObject](objects/Container/addObject.md)|Adds a new object to the container -|[getObject](objects/Container/getObject.md)|Returns an object in the container by its ID -|[getDeepObject](objects/Container/getDeepObject.md)|Returns an object in the container or its sub-containers by its ID -|[removeObject](objects/Container/removeObject.md)|Removes an object from the container by its ID +|[addChild](objects/Container/addChild.md)|Adds a new object to the container +|[getChild](objects/Container/getChild.md)|Returns an object in the container by its ID +|[getDeepChild](objects/Container/getDeepChild.md)|Returns an object in the container or its sub-containers by its ID +|[removeChild](objects/Container/removeChild.md)|Removes an object from the container by its ID +|[removeChildren](objects/Container/removeChildren.md)|Removes all children object's |[updateZIndex](objects/Container/updateZIndex.md)|Updates the Z-index of an object in the container |[setImportant](objects/Container/setImportant.md)|Marks an object as important, so it is displayed on top if needed |[sortElementOrder](objects/Container/sortElementOrder.md)|Sorts the order of elements in the container based on their Z-indices -|[removeFocusedObject](objects/Container/removeFocusedObject.md)|Removes focus from an object in the container -|[setFocusedObject](objects/Container/setFocusedObject.md)|Sets focus on a specific object in the container +|[clearFocusedChild](objects/Container/clearFocusedChild.md)|Removes focus from an object in the container +|[setFocusedChild](objects/Container/setFocusedChild.md)|Sets focus on a specific object in the container A Container Object inherits from VisualObject, but won't draw children objects. diff --git a/docs/objects/Container/addObject.md b/docs/objects/Container/addChild.md similarity index 91% rename from docs/objects/Container/addObject.md rename to docs/objects/Container/addChild.md index 0a1d81e..f1d3813 100644 --- a/docs/objects/Container/addObject.md +++ b/docs/objects/Container/addChild.md @@ -1,4 +1,4 @@ -## addObject +## addChild ### Description diff --git a/docs/objects/Container/removeFocusedObject.md b/docs/objects/Container/clearFocusedChild.md similarity index 68% rename from docs/objects/Container/removeFocusedObject.md rename to docs/objects/Container/clearFocusedChild.md index 057fd49..6db229d 100644 --- a/docs/objects/Container/removeFocusedObject.md +++ b/docs/objects/Container/clearFocusedChild.md @@ -1,8 +1,8 @@ -## removeFocusedObject +## clearFocusedChild ### Description -Removes the focus from the currently focused object within the container. If no object is focused, this method has no effect. +Clears the focus from the currently focused object within the container. If no object is focused, this method has no effect. ### Returns @@ -18,13 +18,13 @@ local inputField1 = container:addInputField() local inputField2 = container:addInputField() :setPosition(2, 4) -container:setFocusedObject(inputField1) +container:setFocusedChild(inputField1) main:addButton() :setPosition(2, 6) :setText("Remove focus from input fields") :onClick(function() - container:removeFocusedObject() + container:clearFocusedChild() basalt.debug("Focus removed from input fields!") end) diff --git a/docs/objects/Container/getObject.md b/docs/objects/Container/getChild.md similarity index 88% rename from docs/objects/Container/getObject.md rename to docs/objects/Container/getChild.md index 3b1c590..a6c5356 100644 --- a/docs/objects/Container/getObject.md +++ b/docs/objects/Container/getChild.md @@ -1,4 +1,4 @@ -## getObject +## getChild ### Description @@ -21,7 +21,7 @@ local button = main:addButton("myButton") :setText("My Button") -- Get the button object by its ID -local retrievedButton = main:getObject("myButton") +local retrievedButton = main:getChild("myButton") if retrievedButton then basalt.debug("Button found!") end diff --git a/docs/objects/Container/getDeepObject.md b/docs/objects/Container/getDeepChild.md similarity index 90% rename from docs/objects/Container/getDeepObject.md rename to docs/objects/Container/getDeepChild.md index c3e1419..dfc9a3d 100644 --- a/docs/objects/Container/getDeepObject.md +++ b/docs/objects/Container/getDeepChild.md @@ -1,4 +1,4 @@ -## getDeepObject +## getDeepChild ### Description @@ -21,7 +21,7 @@ local button = container:addButton("myButton") :setPosition(2, 2) :setText("My Button") -- Get the button object by its ID, searching through all containers -local retrievedButton = main:getDeepObject("myButton") +local retrievedButton = main:getDeepChild("myButton") if retrievedButton then basalt.debug("Button found!") end diff --git a/docs/objects/Container/removeObject.md b/docs/objects/Container/removeChild.md similarity index 90% rename from docs/objects/Container/removeObject.md rename to docs/objects/Container/removeChild.md index 3ce69a8..9748a04 100644 --- a/docs/objects/Container/removeObject.md +++ b/docs/objects/Container/removeChild.md @@ -1,4 +1,4 @@ -## removeObject +## removeChild ### Description @@ -25,7 +25,7 @@ main:addButton() :setPosition(2, 4) :setText("Remove the button above") :onClick(function() - local removed = container:removeObject("removableButton") + local removed = container:removeChild("removableButton") if removed then basalt.debug("Button removed!") else diff --git a/docs/objects/Container/removeChildren.md b/docs/objects/Container/removeChildren.md new file mode 100644 index 0000000..a87e48b --- /dev/null +++ b/docs/objects/Container/removeChildren.md @@ -0,0 +1,22 @@ +## removeChildren + +### Description + +The `removeChildren` method allows you to remove all child objects from a parent container. This is helpful when you want to clear all elements within a container object, such as a frame, and start with a clean slate. + +### Returns + +1. `object` The object in use + +### Usage + +```lua +local mainFrame = basalt.createFrame() + +-- Add some child objects to the frame +mainFrame:addLabel("label1", "Hello", 5, 5) +mainFrame:addButton("button1", "Click Me", 5, 10) + +-- Remove all child objects from the frame +mainFrame:removeChildren() +``` diff --git a/docs/objects/Container/setFocusedObject.md b/docs/objects/Container/setFocusedChild.md similarity index 100% rename from docs/objects/Container/setFocusedObject.md rename to docs/objects/Container/setFocusedChild.md