Button Class Reference

Represents a button. More...

#include <frame.h>

Inheritance diagram for Button:

Collaboration diagram for Button:

Public Member Functions
void	constructor ()
	Constructor for the Button class.
void	init_button ()
	Initializes the button.
void	load ()
	Loads the button resources.
void	update ()
	Updates the state of the button.
void	is_button (bool *result)
	Checks if the current instance is a button.
void	save (FILE *file, Node *editor)
	Saves the state of the editor node to a file.
void	free ()
	Frees the resources used by the button.
Public Member Functions inherited from Frame
void	constructor (float x, int xu, float y, int yu, float w, int wu, float h, int hu, int ha, int va, int scroll, Theme *theme)
	Constructor for initializing a frame object with specified parameters.
void	handle_dimension_unit (float *src, float *dest, int vertical, double size, int unit, double containerWidth, double containerHeight)
	Handles the conversion of dimension units for a given source and destination.
void	init_frame ()
	Initializes the frame.
void	load (FILE *file)
	Loads data from a file.
void	refresh ()
	Refreshes the frame.
void	refreshContent ()
	Refreshes the content of the frame.
void	update ()
	Updates the state of the frame.
void	on_resize ()
	Handles the resize event for the frame.
void	draw_frame ()
	Draws a frame.
void	render (mat4 modelMatrix, Shader activeShader, WorldShaders *shaders)
	Renders a frame using the provided model matrix and shader.
void	save (FILE *file, Node *editor)
	Saves the current state of the editor node to a file.
void	get_vao (VAO *vao)
	Retrieves the Vertex Array Object (VAO).
void	is_gui_element (bool *result)
	Determines if the current object is a GUI element.
void	is_button (bool *result)
	Determines if a button is pressed.
void	is_input_area (bool *result)
	Checks if the current area is an input area.
void	is_selectlist (bool *result)
	Checks if the current item is in the selection list.
void	is_checkbox (bool *result)
	Checks if a condition is a checkbox.
bool	is_radiobutton ()
	Checks if the current frame is a radio button.
void	free ()
	Frees the resources allocated for the frame.
Public Member Functions inherited from Node
void	constructor ()
	Constructor for the Node class.
void	initialize_node ()
	Initializes a node.
void	get_glow_shader (Shader *shader)
	Retrieves the glow shader.
void	get_settings_data (void ***ptr, int *length)
	Retrieves settings data.
void	load ()
	Loads the necessary resources or data for the node.
void	save (FILE *file)
	Saves the current state to the specified file.
void	prepare_render (mat4 modelMatrix, Shader activeShader)
	Renders a node using the specified model matrix and shader.
void	render ()
	Renders the node.
void	update_global_position (vec3 pos, vec3 rot, vec3 scale)
	Updates the global position of a node.
void	update (vec3 pos, vec3 rot, vec3 scale)
	Updates the position, rotation, and scale of a node.
void	on_resize ()
	Handles the resize event for the node.
void	free ()
	Frees the resources allocated by the object.
void	is_cshape (bool *cshape)
	Checks if the current shape is a custom shape.
void	is_body (bool *body)
	Sets the body status of the node.
void	is_area (bool *area)
	Checks if the current node is within a specified area.
void	is_render_target (bool *render_target)
	Sets the render target status.
void	is_gui_element (bool *result)
	Determines if the current node is a GUI element.
void	add_child (Node *child)
	Adds a child node to a parent node.
void	add_child_and_realloc (Node *child)
	Adds a child node to a parent node and reallocates memory if necessary.
void	remove_child (Node *child)
	Removes a child node from a parent node.
void	remove_child_and_realloc (Node *child)
	Removes a child node from a parent node and reallocates memory if necessary.
void	remove_child_and_free (Node *child)
	Removes a child node from a parent node and frees the memory of the child node.
void	remove_child_and_free_and_realloc (Node *child)
	Removes a child node from a parent node, frees the memory of the child node, and reallocates memory if necessary.
int	index_of_child (Node *child)
	Retrieves the index of a child node in a parent node's children array.
void	print (int level)
	Prints the details of a node at a specified level of indentation.
void	emit_ready (...)
	Emits the 'ready' signal for the node.
void	emit_update (...)
	Emits an update event for the node.
void	emit_signal (...)
	Emits a signal if the node has a script and the script has a signal handler.

Public Attributes
ButtonState	state
bool *	checked
Public Attributes inherited from Frame
vec4	overflow
vec2	relPos
vec2	absPos
vec2	scale
vec2	size
vec2	contentSize
vec2	scroll
vec2	scrollTarget
char	unit [4]
char	alignment [2]
Theme *	theme
SDL_Surface *	contentSurface
TextureMap	contentTexture
union {
Label *   label
Button *   button
InputArea *   inputArea
SelectList *   selectList
ImageFrame *   imageFrame
RadioButton *   radiobutton
Slider *   slider
};
FrameFlags	flags
Public Attributes inherited from Node
void *	object
struct Node **	children
struct Node *	parent
u16	length
u8	type
u8	flags
vec3	pos
vec3	rot
vec3	scale
vec3	globalPos
vec3	globalRot
vec3	globalScale
Behavior *	behavior
BehaviorAttribute *	attribute
u8	attributes_count
Shader	shader

Additional Inherited Members
Static Public Attributes inherited from Frame
static VBO	_vbo = 0
	Static variable to store the Vertex Buffer Object (VBO) identifier.
static VAO	_vao = 0
	Static variable to store the Vertex Array Object (VAO) identifier.
Static Public Attributes inherited from Node
static Shader	glowShader = 0
	A static Shader variable used for glow effect.

Detailed Description

Represents a button.

This structure holds information about a button, including its state and whether it is checked. It can also represent a radio button.

Member Function Documentation

constructor()

void Button::constructor ( )

inline

Constructor for the Button class.

This function initializes a new instance of the Button class.

init_button()

void Button::init_button ( )

inline

Initializes the button.

This function sets up the initial state and properties of the button. It should be called before using the button in the application.

load()

void Button::load ( )

inline

Loads the button resources.

This function is responsible for loading the necessary resources for the button, such as textures, sounds, or any other assets required for the button to function properly within the application.

update()

void Button::update ( )

inline

Updates the state of the button.

This function is responsible for updating the button's state, which may include handling user input, updating the button's appearance, and triggering any associated actions or events.

is_button()

void Button::is_button ( bool *  result )

inline

Checks if the current instance is a button.

This function sets the result to true if the current instance is a button, otherwise it sets the result to false.

Parameters

result

A pointer to a boolean variable where the result will be stored.

save()

void Button::save ( FILE *  file, Node *  editor  )

inline

Saves the state of the editor node to a file.

This function writes the current state of the editor node to the specified file.

Parameters

file	A pointer to the FILE object where the editor state will be saved.
editor	A pointer to the Node object representing the editor whose state is to be saved.

free()

void Button::free ( )

inline

Frees the resources used by the button.

This function is responsible for freeing the resources used by the button, such as textures, sounds, or any other assets loaded during the button's lifetime.

Member Data Documentation

state

ButtonState Button::state

Current state of the button.

checked

bool* Button::checked

Pointer to the checked state of the button.

---

The documentation for this class was generated from the following files:

• src/classes/nodes/frames/button.class.c
• src/gui/frame.h