rofi/include/widgets/scrollbar.h

70 lines
1.6 KiB
C
Raw Normal View History

2015-09-03 20:12:20 +00:00
#ifndef ROFI_SCROLLBAR_H
#define ROFI_SCROLLBAR_H
2015-09-26 18:34:34 +00:00
#include <cairo.h>
#include "widgets/widget.h"
#include "widgets/widget-internal.h"
2016-01-07 07:54:24 +00:00
/**
* @defgroup Scrollbar Scrollbar
2016-10-13 07:22:08 +00:00
* @ingroup widget
2016-01-07 07:54:24 +00:00
*
* @{
*/
/**
* Internal structure for the scrollbar.
*/
2015-09-03 20:12:20 +00:00
typedef struct _scrollbar
{
widget widget;
2015-09-03 20:12:20 +00:00
unsigned int length;
unsigned int pos;
unsigned int pos_length;
} scrollbar;
/**
* @param x The x coordinate (relative to parent) to position the new scrollbar
* @param y The y coordinate (relative to parent) to position the new scrollbar
* @param w The width of the scrollbar
* @param h The height of the scrollbar
*
* Create a new scrollbar
*
* @returns the scrollbar object.
*/
2015-09-26 18:34:34 +00:00
scrollbar *scrollbar_create ( short x, short y, short w, short h );
/**
* @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
*/
2016-08-23 22:39:56 +00:00
unsigned int scrollbar_clicked ( const scrollbar *sb, int y );
2016-01-07 07:54:24 +00:00
/*@}*/
2015-09-03 20:12:20 +00:00
#endif // ROFI_SCROLLBAR_H