rofi/include/widgets/scrollbar.h

95 lines
2.5 KiB
C
Raw Normal View History

/*
* rofi
*
* MIT/X11 License
* Copyright © 2013-2017 Qball Cow <qball@gmpclient.org>
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
*/
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;
RofiDistance width;
2015-09-03 20:12:20 +00:00
} scrollbar;
/**
2016-12-11 16:06:31 +00:00
* @param name The name of the widget.
*
* Create a new scrollbar
*
* @returns the scrollbar object.
*/
scrollbar *scrollbar_create ( const char *name );
/**
* @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
*/
guint scrollbar_scroll_get_line ( 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