rofi/include/widgets/separator.h
Dave Davenport b4c599f022 Add more documentation.
Current state: 61% coverage.
2016-10-14 08:47:21 +02:00

41 lines
776 B
C

#ifndef ROFI_SEPARATOR_H
#define ROFI_SEPARATOR_H
#include <cairo.h>
#include "widget.h"
/**
* @defgroup separator separator
* @ingroup widget
*
* Displays a horizontal separator line. The height of the widget determines the line width.
*
* @{
*/
/**
* Abstract handle to the separator widget internal state.
*/
typedef struct _separator separator;
/**
* Direction of the separator.
*/
typedef enum
{
S_HORIZONTAL = 0,
S_VERTICAL = 1
} separator_type;
/**
* @param type The type of separator.
* @param sw The thickness of the separator.
*
* Create a horizontal separator with height h.
*
* @returns a new separator, free with ::widget_free
*/
separator *separator_create ( separator_type type, short sw );
/*@}*/
#endif // ROFI_SEPARATOR_H