1
0
Fork 0
mirror of https://github.com/davatorium/rofi.git synced 2024-11-11 13:50:48 -05:00
rofi/include/widgets/scrollbar.h
2017-01-01 18:08:49 +01:00

74 lines
1.6 KiB
C

#ifndef ROFI_SCROLLBAR_H
#define ROFI_SCROLLBAR_H
#include <cairo.h>
#include "widgets/widget.h"
#include "widgets/widget-internal.h"
/**
* @defgroup Scrollbar Scrollbar
* @ingroup widget
*
* @{
*/
/**
* Internal structure for the scrollbar.
*/
typedef struct _scrollbar
{
widget widget;
unsigned int length;
unsigned int pos;
unsigned int pos_length;
} scrollbar;
/**
* @param name The name of the widget.
* @param width The width of the scrollbar
*
* Create a new scrollbar
*
* @returns the scrollbar object.
*/
scrollbar *scrollbar_create ( const char *name, int width );
/**
* @param sb scrollbar object
* @param pos_length new length
*
* set the length of the handle relative to the max value of bar.
*/
void scrollbar_set_handle_length ( scrollbar *sb, unsigned int pos_length );
/**
* @param sb scrollbar object
* @param pos new position
*
* set the position of the handle relative to the set max value of bar.
*/
void scrollbar_set_handle ( scrollbar *sb, unsigned int pos );
/**
* @param sb scrollbar object
* @param max the new max
*
* set the max value of the bar.
*/
void scrollbar_set_max_value ( scrollbar *sb, unsigned int max );
/**
* @param sb scrollbar object
* @param y clicked position
*
* Calculate the position of the click relative to the max value of bar
*/
unsigned int scrollbar_clicked ( const scrollbar *sb, int y );
/**
* @param sb scrollbar object
* @param width width of the scrollbar
*
* Set the width of the scrollbar handle.
*/
void scrollbar_set_width ( scrollbar *sb, int width );
/*@}*/
#endif // ROFI_SCROLLBAR_H