listview.h

Go to the documentation of this file.

/*
 * 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.
 *
 */
 
#ifndef ROFI_LISTVIEW_H
#define ROFI_LISTVIEW_H
 
#include "widgets/textbox.h"
 
typedef struct _listview listview;
 
typedef enum {
  LISTVIEW_SCROLL_PER_PAGE,
  LISTVIEW_SCROLL_CONTINIOUS
} ScrollType;
 
typedef void (*listview_update_callback)(textbox *tb, icon *ico,
                                         unsigned int entry, void *udata,
                                         TextBoxFontType *type, gboolean full);
 
typedef void (*listview_mouse_activated_cb)(listview *, gboolean, void *);
 
listview *listview_create(widget *parent, const char *name,
                          listview_update_callback cb, void *udata,
                          unsigned int eh, gboolean reverse);
 
void listview_set_num_elements(listview *lv, unsigned int rows);
 
void listview_set_selected(listview *lv, unsigned int selected);
 
unsigned int listview_get_selected(listview *lv);
 
void listview_nav_up(listview *lv);
void listview_nav_down(listview *lv);
void listview_nav_right(listview *lv);
void listview_nav_left(listview *lv);
void listview_nav_page_next(listview *lv);
 
void listview_nav_page_prev(listview *lv);
 
void listview_set_show_scrollbar(listview *lv, gboolean enabled);
void listview_set_scrollbar_width(listview *lv, unsigned int width);
 
void listview_set_cycle(listview *lv, gboolean cycle);
void listview_set_scroll_type(listview *lv, ScrollType type);
 
void listview_set_mouse_activated_cb(listview *lv,
                                     listview_mouse_activated_cb cb,
                                     void *udata);
void listview_set_multi_select(listview *lv, gboolean enable);
void listview_set_num_lines(listview *lv, unsigned int num_lines);
 
gboolean listview_get_fixed_num_lines(listview *lv);
 
void listview_set_fixed_num_lines(listview *lv);
 
void listview_set_max_lines(listview *lv, unsigned int max_lines);
 
void listview_toggle_ellipsizing(listview *lv);
 
void listview_set_ellipsize_start(listview *lv);
#endif // ROFI_LISTVIEW_H