herrie: gui_vfslist.h Source File

00001 /*
00002  * Copyright (c) 2006-2009 Ed Schouten <ed@80386.nl>
00003  * All rights reserved.
00004  * 
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions
00007  * are met:
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 
00014  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
00015  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00016  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00017  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
00018  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00019  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00020  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00021  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00022  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00023  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00024  * SUCH DAMAGE.
00025  */
00031 #include CURSES_HEADER
00032 
00033 struct vfslist;
00034 struct vfsref;
00035 struct vfsmatch;
00036 
00040 struct gui_vfslist {
00044         WINDOW          *win;
00048         unsigned int    winheight;
00052         unsigned int    winfocused;
00056         int             shownumbers;
00057 
00061         const struct vfslist *list;
00065         struct vfsref   *vr_top;
00069         unsigned int    idx_top;
00073         struct vfsref   *vr_selected;
00077         unsigned int    idx_selected;
00078 
00083         char            percent[8];
00084 
00088         void            (*callback)(void);
00089 };
00090 
00094 struct gui_vfslist *gui_vfslist_new(int shownumbers);
00098 void gui_vfslist_destroy(struct gui_vfslist *gv);
00102 void gui_vfslist_setlist(struct gui_vfslist *gv, const struct vfslist *vl);
00106 int gui_vfslist_warn_isempty(struct gui_vfslist *gv);
00110 void gui_vfslist_move(struct gui_vfslist *gv, int x, int y,
00111     int width, int height);
00116 void gui_vfslist_setfocus(struct gui_vfslist *gv, int focus);
00120 void gui_vfslist_setselected(struct gui_vfslist *gv, struct vfsref *vr,
00121     unsigned int index);
00122 
00126 static inline struct vfsref *
00127 gui_vfslist_getselected(struct gui_vfslist *gv)
00128 {
00129         return (gv->vr_selected);
00130 }
00131 
00135 static inline unsigned int
00136 gui_vfslist_getselectedidx(struct gui_vfslist *gv)
00137 {
00138         return (gv->idx_selected);
00139 }
00140 
00144 void gui_vfslist_cursor_up(struct gui_vfslist *gv);
00148 void gui_vfslist_cursor_down(struct gui_vfslist *gv, int silent);
00152 void gui_vfslist_cursor_head(struct gui_vfslist *gv);
00156 void gui_vfslist_cursor_tail(struct gui_vfslist *gv);
00160 void gui_vfslist_cursor_pageup(struct gui_vfslist *gv);
00164 void gui_vfslist_cursor_pagedown(struct gui_vfslist *gv);
00165 
00169 static inline const char *
00170 gui_vfslist_getpercentage(struct gui_vfslist *gv)
00171 {
00172         return (gv->percent);
00173 }
00174 
00178 static inline void
00179 gui_vfslist_setcallback(struct gui_vfslist *gv, void (*func)(void))
00180 {
00181         gv->callback = func;
00182 }
00183 
00188 void gui_vfslist_notify_pre_removal(struct gui_vfslist *gv,
00189     unsigned int index);
00194 void gui_vfslist_notify_post_insertion(struct gui_vfslist *gv,
00195     unsigned int index);
00199 void gui_vfslist_notify_post_randomization(struct gui_vfslist *gv);
00204 void gui_vfslist_notify_done(struct gui_vfslist *gv);
00209 int gui_vfslist_searchnext(struct gui_vfslist *gv, const struct vfsmatch *vm);
00214 void gui_vfslist_fullpath(struct gui_vfslist *gv);