rofi/include/widgets/box.h

53 lines
1.2 KiB
C
Raw Normal View History

#ifndef ROFI_HBOX_H
#define ROFI_HBOX_H
#include "widget.h"
/**
* @defgroup box box
2016-10-13 07:22:08 +00:00
* @ingroup widget
*
2016-10-09 07:30:57 +00:00
* Widget used to pack multiple widgets either horizontally or vertically.
* It supports packing widgets horizontally or vertically. Child widgets are always
* expanded to the maximum size in the oposite direction of the packing direction.
* e.g. vertically packed widgets use the full box width.
*
* @{
*/
/**
* Abstract handle to the box widget internal state.
*/
typedef struct _box box;
2016-10-09 07:30:57 +00:00
/**
* The packing direction of the box
*/
typedef enum
{
2016-10-09 07:30:57 +00:00
/** Pack widgets horizontal */
BOX_HORIZONTAL,
2016-10-09 07:30:57 +00:00
/** Pack widgets vertical */
BOX_VERTICAL
} boxType;
2016-10-09 07:30:57 +00:00
/**
2016-12-11 11:19:46 +00:00
* @param name The name of the widget.
2016-10-09 07:30:57 +00:00
* @param type The packing direction of the newly created box.
*
* @returns a newly created box, free with #widget_free
*/
box * box_create ( const char *name, boxType type );
2016-10-09 07:30:57 +00:00
/**
* @param box Handle to the box widget.
* @param child Handle to the child widget to pack.
* @param expand If the child widget should expand and use all available space.
* @param index The position index.
2016-10-09 07:30:57 +00:00
*
* Add a widget to the box.
*/
void box_add ( box *box, widget *child, gboolean expand, int index );
/*@}*/
#endif // ROFI_HBOX_H