mirror of https://github.com/fltk/fltk
111 lines
3.5 KiB
C++
111 lines
3.5 KiB
C++
//
|
|
// Fl_Check_Browser header file for the Fast Light Tool Kit (FLTK).
|
|
//
|
|
// Copyright 1998-2020 by Bill Spitzak and others.
|
|
//
|
|
// This library is free software. Distribution and use rights are outlined in
|
|
// the file "COPYING" which should have been included with this file. If this
|
|
// file is missing or damaged, see the license at:
|
|
//
|
|
// https://www.fltk.org/COPYING.php
|
|
//
|
|
// Please see the following page on how to report bugs and issues:
|
|
//
|
|
// https://www.fltk.org/bugs.php
|
|
//
|
|
|
|
/* \file
|
|
Fl_Check_Browser widget . */
|
|
|
|
#ifndef Fl_Check_Browser_H
|
|
#define Fl_Check_Browser_H
|
|
|
|
#include "Fl.H"
|
|
#include "Fl_Browser_.H"
|
|
|
|
/**
|
|
The Fl_Check_Browser widget displays a scrolling list of text
|
|
lines that may be selected and/or checked by the user.
|
|
*/
|
|
class FL_EXPORT Fl_Check_Browser : public Fl_Browser_ {
|
|
|
|
protected:
|
|
/* required routines for Fl_Browser_ subclass: */
|
|
void *item_first() const FL_OVERRIDE;
|
|
void *item_next(void *) const FL_OVERRIDE;
|
|
void *item_prev(void *) const FL_OVERRIDE;
|
|
int item_height(void *) const FL_OVERRIDE;
|
|
int item_width(void *) const FL_OVERRIDE;
|
|
void item_draw(void *, int, int, int, int) const FL_OVERRIDE;
|
|
void item_select(void *, int) FL_OVERRIDE;
|
|
int item_selected(void *) const FL_OVERRIDE;
|
|
const char *item_text(void *item) const FL_OVERRIDE;
|
|
|
|
public:
|
|
void *item_at(int index) const FL_OVERRIDE;
|
|
void item_swap(int ia, int ib);
|
|
void item_swap(void *a, void *b) FL_OVERRIDE;
|
|
|
|
/* private data */
|
|
|
|
public: // IRIX 5.3 C++ compiler doesn't support private structures...
|
|
|
|
#ifndef FL_DOXYGEN
|
|
/** For internal use only. */
|
|
struct cb_item {
|
|
cb_item *next; /**< For internal use only. */
|
|
cb_item *prev; /**< For internal use only. */
|
|
char checked; /**< For internal use only. */
|
|
char selected; /**< For internal use only. */
|
|
char *text; /**< For internal use only. */
|
|
};
|
|
#endif // !FL_DOXYGEN
|
|
|
|
private:
|
|
cb_item *first;
|
|
cb_item *last;
|
|
cb_item *cache;
|
|
int cached_item;
|
|
int nitems_;
|
|
int nchecked_;
|
|
cb_item *find_item(int) const;
|
|
int lineno(cb_item *) const;
|
|
|
|
public:
|
|
Fl_Check_Browser(int x, int y, int w, int h, const char *l = 0);
|
|
/** The destructor deletes all list items and destroys the browser. */
|
|
~Fl_Check_Browser() { clear(); }
|
|
int add(char *s); // add an (unchecked) item
|
|
int add(char *s, int b); // add an item and set checked
|
|
// both return the new nitems()
|
|
int remove(int item); // delete an item. Returns nitems()
|
|
|
|
// inline const char * methods to avoid breaking binary compatibility...
|
|
/** See int Fl_Check_Browser::add(char *s) */
|
|
int add(const char *s) { return add((char *)s); }
|
|
/** See int Fl_Check_Browser::add(char *s) */
|
|
int add(const char *s, int b) { return add((char *)s, b); }
|
|
|
|
void clear(); // delete all items
|
|
/**
|
|
Returns how many lines are in the browser. The last line number is equal to
|
|
this.
|
|
*/
|
|
int nitems() const { return nitems_; }
|
|
/** Returns how many items are currently checked. */
|
|
int nchecked() const { return nchecked_; }
|
|
int checked(int item) const;
|
|
void checked(int item, int b);
|
|
/** Equivalent to Fl_Check_Browser::checked(item, 1). */
|
|
void set_checked(int item) { checked(item, 1); }
|
|
void check_all();
|
|
void check_none();
|
|
int value() const; // currently selected item
|
|
char *text(int item) const; // returns pointer to internal buffer
|
|
|
|
protected:
|
|
int handle(int) FL_OVERRIDE;
|
|
};
|
|
|
|
#endif // Fl_Check_Browser_H
|