diff --git a/docs/references/elements/BaseFrame.md b/docs/references/elements/BaseFrame.md index 82fb892..7df6498 100644 --- a/docs/references/elements/BaseFrame.md +++ b/docs/references/elements/BaseFrame.md @@ -18,9 +18,6 @@ This is the base frame class. It is the root element of all elements and the onl |Method|Returns|Description| |---|---|---| -|[BaseFrame:char](#BaseFrame:char)|-| -|[BaseFrame:key](#BaseFrame:key)|-| -|[BaseFrame:key_up](#BaseFrame:key_up)|-| |[BaseFrame:setCursor](#BaseFrame:setCursor)|-|Sets the cursor position @@ -29,7 +26,10 @@ This is the base frame class. It is the root element of all elements and the onl |Method|Returns|Description| |---|---|---| |[BaseFrame:blit](#BaseFrame:blit)|-|Renders a text with a foreground and background color to the render Object +|[BaseFrame:char](#BaseFrame:char)|-|Handles character events |[BaseFrame:init](#BaseFrame:init)|table|Initializes the Frame instance +|[BaseFrame:key](#BaseFrame:key)|-|Handles key events +|[BaseFrame:key_up](#BaseFrame:key_up)|-|Handles key up events |[BaseFrame:mouse_up](#BaseFrame:mouse_up)|-|Handles mouse up events |[BaseFrame:multiBlit](#BaseFrame:multiBlit)|-|Renders a multiBlit to the render Object |[BaseFrame:render](#BaseFrame:render)|-|Renders the Frame @@ -37,12 +37,6 @@ This is the base frame class. It is the root element of all elements and the onl |[BaseFrame:textBg](#BaseFrame:textBg)|-|Renders a text with a background color to the render Object |[BaseFrame:textFg](#BaseFrame:textFg)|-|Renders a text with a foreground color to the render Object -## BaseFrame:char() - -## BaseFrame:key() - -## BaseFrame:key_up() - ## BaseFrame:setCursor(x, y, blink) Sets the cursor position diff --git a/docs/references/elements/VisualElement.md b/docs/references/elements/VisualElement.md index b635710..cb3989a 100644 --- a/docs/references/elements/VisualElement.md +++ b/docs/references/elements/VisualElement.md @@ -50,12 +50,9 @@ and provides core functionality for positioning, sizing, colors, and rendering. |Method|Returns|Description| |---|---|---| |[VisualElement:calculatePosition](#VisualElement:calculatePosition)|number|Calculates the position of the element -|[VisualElement:char](#VisualElement:char)|-| |[VisualElement:getAbsolutePosition](#VisualElement:getAbsolutePosition)|number|Returns the absolute position of the element |[VisualElement:getRelativePosition](#VisualElement:getRelativePosition)|number|Returns the relative position of the element |[VisualElement:isInBounds](#VisualElement:isInBounds)|boolean|Checks if point is within bounds -|[VisualElement:key](#VisualElement:key)|-| -|[VisualElement:key_up](#VisualElement:key_up)|-| |[VisualElement:prioritize](#VisualElement:prioritize)|VisualElement|Prioritizes the element by moving it to the top of its parent's children @@ -65,8 +62,11 @@ and provides core functionality for positioning, sizing, colors, and rendering. |---|---|---| |[VisualElement:blit](#VisualElement:blit)|-|Draws text with both colors |[VisualElement:blur](#VisualElement:blur)|-|Handles a blur event +|[VisualElement:char](#VisualElement:char)|-|Handles a character event |[VisualElement:focus](#VisualElement:focus)|-|Handles a focus event |[VisualElement:init](#VisualElement:init)|-|Initializes a new visual element with properties +|[VisualElement:key](#VisualElement:key)|-|Handles a key event +|[VisualElement:key_up](#VisualElement:key_up)|-|Handles a key up event |[VisualElement:mouse_click](#VisualElement:mouse_click)|boolean|Handles a mouse click event |[VisualElement:mouse_drag](#VisualElement:mouse_drag)|boolean|Handles a mouse drag event |[VisualElement:mouse_move](#VisualElement:mouse_move)|boolean|Handles a mouse move event @@ -86,8 +86,6 @@ Calculates the position of the element relative to its parent * `number` `x` The x position * `number` `y` The y position -## VisualElement:char() - ## VisualElement:getAbsolutePosition(x?, y?) Returns the absolute position of the element or the given coordinates. @@ -120,10 +118,6 @@ Checks if the specified coordinates are within the bounds of the element ### Returns * `boolean` `isInBounds` Whether the coordinates are within the bounds of the element -## VisualElement:key() - -## VisualElement:key_up() - ## VisualElement:prioritize() This function is used to prioritize the element by moving it to the top of its parent's children. It removes the element from its parent and adds it back, effectively changing its order.