Basic documentation up

trymbf · trymbf · commit a9a2a344bd26 · 2025-03-21T22:14:15.000+01:00
still need exampels and rounting
diff --git a/__pycache__/pygameui.cpython-313.pyc b/__pycache__/pygameui.cpython-313.pyc
diff --git a/docs/components/button.md b/docs/components/button.md
@@ -51,3 +51,30 @@ centered: bool = False
 - `font_size`: Size of the text font
 - `font_family`: Font family for the text
 - `centered`: If True, the button is centered on the provided position
+
+## Methods
+All methods inherited from the [Element](element.md) class.
+
+(Some methods may not be applicable to the Image class, but are included for consistency.)
+
+### Setters
+```python
+set_label(label: str) -> None
+set_color(color: tuple[int, int, int]) -> None
+set_hover_color(color: tuple[int, int, int]) -> None
+set_click_color(color: tuple[int, int, int]) -> None
+set_text_color(color: tuple[int, int, int]) -> None
+set_text_hover_color(color: tuple[int, int, int]) -> None
+set_text_click_color(color: tuple[int, int, int]) -> None
+```
+
+- `set_label`: Set the text displayed on the button
+- `set_color`: Set the default button background color
+- `set_hover_color`: Set the background color when the button is hovered over
+- `set_click_color`: Set the background color when the button is clicked
+- `set_text_color`: Set the color of the buttonlabel when not hovered
+- `set_text_hover_color`: Set the color of the buttonlabel when hovered over
+- `set_text_click_color`: Set the color of the buttonlabel when clicked
+
+### Mouse and Click Events
+See the [Mouse and Click Events](element.md#mouse-and-click-events) section in the Element documentation.
diff --git a/docs/components/element.md b/docs/components/element.md
@@ -34,37 +34,72 @@ centered: bool = False
 
 ## Methods
 
-### Position Control
+### Basic methods
 ```python
-# Set new position
-element.set_position((200, 200))
-
-# Get current position
-pos = element.get_position()
+draw(surface: pygame.Surface) -> None
+update() -> None
+```
+- `draw`: Draws the element on the provided surface.
+- `update`: Updates the element's state. This method should be called every frame to ensure animations and events are processed.
 
-# Center the element
-element.centered = True
+### Setters
+```python
+set_position(position: tuple[int,int]) -> None
+set_framerate(framerate: int) -> None
+set_display(display: bool) -> None
+set_color(color: tuple[int, int, int]) -> None
+set_border_radius(radius: int) -> None
+set_animate(state: bool) -> None
 ```
 
-### Display Control
+- `set_position`: Set the position of the element
+- `set_framerate`: Set the framerate for the elements animations
+- `set_display`: If set True, the element is drawn when element.draw is called
+- `set_color`: Set the color of the element
+- `set_border_radius`: Set the border radius of the element
+- `set_animate`: If set True, the elements set animations are will be preformed when the element is updated
+
+### Getters
 ```python
-# Hide element
-element.set_display(False)
+get_position() -> tuple[int, int]
+get_display() -> bool
+get_animation_state() -> bool
+```
+
+- `get_position`: Get the current position of the element, if the element is centered, the returned position is the center of the element
+- `get_display`: Get the display state of the element
+- `get_animation_state`: Get the animation state of the element, if the element is being animated, the returned value is True, otherwise False
 
-# Show element
-element.set_display(True)
 
-# Toggle visibility
-element.toggle_display()
+### Animations
+
+```python
+flow(
+    start_position: tuple[int, int],
+    end_position: tuple[int, int],
+    time: int,
+    loop: bool = False
+    ) -> None
+
+jump(
+    start_position: tuple[int, int],
+    end_position: tuple[int, int],
+    time: int,
+    loop: bool = False,
+    ratio: float = 1
+    ) -> None
 ```
+- `flow`: Moves the element from start_position to end_position over a specified time. If loop is True, the animation will repeat.
 
-### Mouse Interaction
+- `jump`: Teleports the element from start_position to end_position over a specified time. If loop is True, the animation will repeat.
+
+### Mouse and Click Events
 ```python
-# Check if mouse is over element
-if element.is_hovered():
-    print("Mouse over!")
-
-# Check if element is clicked
-if element.is_clicked():
-    print("Clicked!")
-```
+is_hovered() -> bool
+is_clicked(button: int = 1) -> bool
+was_clicked() -> bool
+```
+
+- `is_hovered`: Check if the mouse is hovering over the element. Returns True if hovered, False otherwise.
+- `is_clicked`: Check if the element is hovered and the provided mouse button is down. Returns True if clicked, False otherwise. The default button is 1 (left mouse button).
+- `was_clicked`: Check if the element was clicked in the last frame. Returns True if clicked, False otherwise.
diff --git a/docs/components/image.md b/docs/components/image.md
@@ -46,21 +46,26 @@ Three ways to control image size:
 2. Scale factor (`scale` parameter)
 3. Exact dimensions (`width` and `height` parameters)
 
-## Performance Tips
+## Methods
 
+All methods inherited from the [Element](element.md) class.
+
+(Some methods may not be applicable to the Image class, but are included for consistency.)
+
+### Setters
+```python
+set_image(image_path: str) -> None
+scale(scale: int) -> None
+```
+- `set_image`: Set a new image for the element
+- `scale`: Set a new scale for the image
+
+### Getters
 ```python
-# Efficient loading for multiple instances
-shared_image = pygame.image.load("sprite.png")
-for pos in positions:
-    image = pygameui.Image(
-        position=pos,
-        image=shared_image
-    )
+get_image() -> pygame.Surface
+get_scale() -> int
 ```
 
-## Best Practices
+- `get_image`: Get the current image of the element
+- `get_scale`: Get the current scale of the image
 
-- Use appropriate image sizes
-- Convert images to PNG for transparency
-- Cache frequently used images
-- Consider memory usage with large images
diff --git a/docs/components/index.md b/docs/components/index.md
@@ -1,7 +1,5 @@
 # Components Guide
 
-**Next:** [Animation Guide](../animation.md) | **Previous:** [Basic Tutorial](../tutorials/basic.md)
-
 ## Available Components
 
 1. [Element](element.md) - Base component
@@ -27,28 +25,3 @@
 5. [Image](image.md) - Image display
    - Multiple formats
    - Scaling options
-   - Performance optimization
-
-## Usage Examples
-
-Each component page includes:
-- Basic implementation
-- Available properties
-- Common use cases
-- Performance tips
-
-## Quick Reference
-
-```python
-# Basic element creation pattern
-element = pygameui.ComponentName(
-    position=(x, y),
-    # ... other properties
-)
-
-# Update and draw pattern
-element.update()  # or element.update(events)
-element.draw(screen)
-```
-
-**Next:** Learn about [Animation](../animation.md)
diff --git a/docs/components/input.md b/docs/components/input.md
@@ -44,18 +44,36 @@ centered: bool = False
 - `hint`: Placeholder text when the field is empty
 - `centered`: If True, the element is centered on the provided position
 
-### Input Features
-- Text filtering
-- Custom borders
-- Active/inactive states
-- Cursor navigation
-- Text selection
-
-### Input Filtering
+## Methods
+All methods inherited from the [Element](element.md) class.
+
+(Some methods may not be applicable to the Image class, but are included for consistency.)
+
+### Basic methods
+```python
+draw(surface: pygame.Surface) -> None
+update(events: list) -> None
+```
+
+- `draw`: Draws the input field on the provided surface.
+- `update`: Updates the input field and processes events. The `events` parameter should be the list of events from `pygame.event.get()`, se [Basic structure](../getting-started.md#Basic-Structure). This method should be called every frame to ensure animations and events are processed.
+
+### Setters
 ```python
-# Only allow numbers
-input_field.set_filter("0123456789", exclude_mode=False)
+set_max_length(length: int) -> None
+set_filter(filter: str, only_allow_filter: bool = False) -> None
+set_hint(hint: str) -> None
+set_value(value: str) -> None
+```
+
+- `set_max_length`: Set the maximum length of the input field.
+- `set_filter`: Set a filter for the input field. The `filter` parameter can be a string of characters. If `only_allow_filter` is set to False, only characters in the filter will be allowed. If set to True, all characters except those in the filter will be allowed.
+- `set_hint`: Set the hint text for the input field.
+- `set_value`: Set the current value of the input field.
+
+### Getters
+```python
+get_value() -> str
+```
 
-# Exclude special characters
-input_field.set_filter("@#$%^&*()", exclude_mode=True)
-```
+- `get_value`: Get the current value of the input field.
diff --git a/docs/components/text.md b/docs/components/text.md
@@ -24,6 +24,7 @@ font_size: int = 20,
 font_family: str = "Arial",
 width: int = 0,
 height: int = 0,
+anti_aliasing: bool = True,
 centered: bool = False
 ```
 - `position`: Tuple of (x, y) coordinates
@@ -33,19 +34,34 @@ centered: bool = False
 - `font_family`: Font family to use
 - `width`: Width of the text box (0 for auto)
 - `height`: Height of the text box (0 for auto)
+- `anti_aliasing`: If True, the text is anti-aliased meaning smoother edges
 - `centered`: If True, the text is centered on the provided position
 
 ## Methods
+All methods inherited from the [Element](element.md) class.
 
-### Text Manipulation
+(Some methods may not be applicable to the Image class, but are included for consistency.)
+
+### Setters
 ```python
-# Change text content
-text.change_text("New text")
+set_content(content: str) -> None
+set_color(color: tuple[int, int, int]) -> None
+set_font_size(font_size: int) -> None
+set_font_family(font_family: str) -> None
+```
+
+- `set_content`: Set the text content
+- `set_color`: Set the text color
+- `set_font_size`: Set the font size
+- `set_font_family`: Set the font family
 
-# Change text color
-text.change_text_color((255, 0, 0))
+### Getters
+```python
+get_content() -> str
 ```
 
+- `get_content`: Get the current text content
+
 ## Font Support
 
 Supported font families:
diff --git a/examples/login_screen.py b/examples/login_screen.py
@@ -67,8 +67,8 @@
 
 # Handle login attempt
 def attempt_login():
-    username = username_input.get_text()
-    password = password_input.get_text()
+    username = username_input.get_value()
+    password = password_input.get_value()
     
     if username == "admin" and password == "password":
         status_msg.change_text("Login successful!")
diff --git a/pygameui.py b/pygameui.py
diff --git a/test.py b/test.py
