Files
tgbot/include/types.h
2025-09-16 23:53:50 +02:00

71 lines
2.4 KiB
C

#ifndef TGBOT_TYPES_H
#define TGBOT_TYPES_H
#include "common.h"
#define TEXT_SIZE 200
#define URL_SIZE 200
#define CB_DATA_SIZE 64
/**
* @brief Represents a single button on an inline keyboard.
*/
typedef struct tgbot_inlinekeyboardbutton {
char text[TEXT_SIZE]; /**< Text of the button. If empty, the button is ignored. */
char url[URL_SIZE]; /**< (Optional) URL to be opened when the button is pressed. */
char callback_data[CB_DATA_SIZE]; /**< (Optional) Data sent to the bot when the button is pressed. */
} tgbot_inlinekeyboardbutton_s;
/**
* @brief Represents an inline keyboard.
*/
typedef struct tgbot_inlinekeyboard {
size_t rows; /**< Number of rows in the keyboard. */
size_t columns; /**< Number of columns per row. */
tgbot_inlinekeyboardbutton_s *buttons; /**< Array of buttons. */
} tgbot_inlinekeyboard_s;
/**
* @brief Allocates a new inline keyboard.
*
* @param[in] rows Number of rows in the keyboard.
* @param[in] columns Number of columns in each row.
*
* @return The pointer to the keyboard or NULL on allocation failure.
*/
tgbot_inlinekeyboard_s *tgbot_inlinekb_new(size_t rows, size_t columns);
/**
* @brief Adds or updates a button at the specified position in the keyboard.
*
* @param[out] keyboard Pointer to the keyboard to modify.
* @param[in] row Row index of the button (starting from 0).
* @param[in] column Column index of the button (starting from 0).
* @param[in] text Display text for the button.
* @param[in] url Optional URL for the button.
* @param[in] callback_data Optional callback data for the button.
*
* @return TGBOT_OK on success.
*/
tgbot_rc tgbot_inlinekb_button(tgbot_inlinekeyboard_s *keyboard, size_t row, size_t column, const char *text, const char *url, const char *callback_data);
/**
* @brief Returns a pointer to the keyboard's button.
*
* @param[in] keyboard Keyboard.
* @param[in] row Row index of the button.
* @param[in] column Column index of the button.
*
* @return Pointer to the button, or NULL if the position is invalid.
*/
tgbot_inlinekeyboardbutton_s *tgbot_inlinekb_button_at(tgbot_inlinekeyboard_s *keyboard, size_t row, size_t column);
/**
* @brief Frees all memory associated with the given inline keyboard.
*
* @param[in,out] keyboard Pointer to the keyboard structure to deallocate.
*/
void tgbot_inlinekb_free(tgbot_inlinekeyboard_s *keyboard);
#endif