rofi/include/widgets/widget.h
2016-10-13 09:22:08 +02:00

150 lines
3.6 KiB
C

#ifndef ROFI_WIDGET_H
#define ROFI_WIDGET_H
#include <glib.h>
#include <cairo.h>
#include <xcb/xcb.h>
#include <xcb/xproto.h>
/**
* @defgroup widget widget
*
* Generic abstract widget class. Widgets should 'inherit' from this class (first structure in there structure should be
* widget).
* The generic widget implements generic functions like get_width, get_height, draw, resize, update, free and
* clicked.
* It also holds information about how the widget should be packed.
*
* @{
*/
typedef struct _widget widget;
/**
* Callback for when widget is clicked.
*/
typedef gboolean ( *widget_clicked_cb )( widget *, xcb_button_press_event_t *, void * );
/** Macro to get widget from an implementation (e.g. textbox/scrollbar) */
#define WIDGET( a ) ( ( a ) != NULL ? (widget *) ( a ) : NULL )
/**
* @param widget The widget to check
* @param x The X position relative to parent window
* @param y the Y position relative to parent window
*
* Check if x,y falls within the widget.
*
* @return TRUE if x,y falls within the widget
*/
int widget_intersect ( const widget *widget, int x, int y );
/**
* @param widget The widget to move
* @param x The new X position relative to parent window
* @param y The new Y position relative to parent window
*
* Moves the widget.
*/
void widget_move ( widget *widget, short x, short y );
/**
* @param widget Handle to widget
*
* Check if widget is enabled.
* @returns TRUE when widget is enabled.
*/
gboolean widget_enabled ( widget *widget );
/**
* @param widget Handle to widget
*
* Disable the widget.
*/
void widget_disable ( widget *widget );
/**
* @param widget Handle to widget
*
* Enable the widget.
*/
void widget_enable ( widget *widget );
/**
* @param tb Handle to the widget
* @param draw The cairo object used to draw itself.
*
* Render the textbox.
*/
void widget_draw ( widget *widget, cairo_t *d );
/**
* @param tb Handle to the widget
*
* Free the widget and all allocated memory.
*/
void widget_free ( widget *widget );
/**
* @param widget The widget toresize
* @param w The new width
* @param h The new height
*
* Resizes the widget.
*/
void widget_resize ( widget *widget, short w, short h );
/**
* @param widget The widget handle
*
* @returns the height of the widget.
*/
int widget_get_height ( widget *widget );
/**
* @param widget The widget handle
*
* @returns the width of the widget.
*/
int widget_get_width ( widget *widget );
/**
* @param widget The widget handle
*
* Update the widget, and its parent recursively.
* This should be called when size of widget changes.
*/
void widget_update ( widget *widget );
/**
* @param widget The widget handle
*
* Indicate that the widget needs to be redrawn.
* This is done by setting the redraw flag on the toplevel widget.
*/
void widget_queue_redraw ( widget *widget );
/**
* @param widget The widget handle
*
* Check the flag indicating the widget needs to be redrawn.
*/
gboolean widget_need_redraw ( widget *wid );
/**
* @param wid The widget handle
* @param xbe The button press event
*
* Signal the widget that it has been clicked,
* The click should have happened within the region of the widget, check with
* ::widget_intersect.
*
* @returns returns TRUE if click is handled.
*/
gboolean widget_clicked ( widget *wid, xcb_button_press_event_t *xbe );
/**
* @param wid The widget handle
* @param cb The widget click callback
* @param udata the user data to pass to callback
*
* Override the widget clicked handler on widget.
*/
void widget_set_clicked_handler ( widget *wid, widget_clicked_cb cb, void *udata );
/*@}*/
#endif // ROFI_WIDGET_H