Fl_Browser.H

//
// Browser header file for the Fast Light Tool Kit (FLTK).
//
// Copyright 1998-2023 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_Browser widget . */
 
// Forms-compatible browser.  Probably useful for other
// lists of textual data.  Notice that the line numbers
// start from 1, and 0 means "no line".
 
#ifndef Fl_Browser_H
#define Fl_Browser_H
 
#include "Fl_Browser_.H"
#include "Fl_Image.H"
 
struct FL_BLINE;

class FL_EXPORT Fl_Browser : public Fl_Browser_ {
 
  FL_BLINE *first;              // the array of lines
  FL_BLINE *last;
  FL_BLINE *cache;
  int cacheline;                // line number of cache
  int lines;                    // Number of lines
  int full_height_;
  const int* column_widths_;
  char format_char_;            // alternative to @-sign
  char column_char_;            // alternative to tab
 
protected:
 
  // required routines for Fl_Browser_ subclass:
  void* item_first() const FL_OVERRIDE;
  void* item_next(void* item) const FL_OVERRIDE;
  void* item_prev(void* item) const FL_OVERRIDE;
  void* item_last()const FL_OVERRIDE;
  int item_selected(void* item) const FL_OVERRIDE;
  void item_select(void* item, int val) FL_OVERRIDE;
  int item_height(void* item) const FL_OVERRIDE;
  int item_width(void* item) const FL_OVERRIDE;
  void item_draw(void* item, int X, int Y, int W, int H) const FL_OVERRIDE;
  int full_height() const FL_OVERRIDE;
  int incr_height() const FL_OVERRIDE;
  const char *item_text(void *item) const FL_OVERRIDE;
  void item_swap(void *a, void *b) FL_OVERRIDE { swap((FL_BLINE*)a, (FL_BLINE*)b); }
  void *item_at(int line) const FL_OVERRIDE { return (void*)find_line(line); }
 
  FL_BLINE* find_line(int line) const ;
  FL_BLINE* _remove(int line) ;
  void insert(int line, FL_BLINE* item);
  int lineno(void *item) const ;
  void swap(FL_BLINE *a, FL_BLINE *b);
 
public:
 
  void remove(int line);
  void add(const char* newtext, void* d = 0);
  void insert(int line, const char* newtext, void* d = 0);
  void move(int to, int from);
  int  load(const char* filename);
  void swap(int a, int b);
  void clear();

  int size() const { return lines; }
  void size(int W, int H) { Fl_Widget::size(W, H); }

  Fl_Fontsize textsize() const { return Fl_Browser_::textsize(); }
 
  /*
    Sets the default text size for the lines in the browser to newSize.
    Defined and documented in Fl_Browser.cxx
  */
  void textsize(Fl_Fontsize newSize);
 
  int topline() const ;
  enum Fl_Line_Position { TOP, BOTTOM, MIDDLE };
  void lineposition(int line, Fl_Line_Position pos);
  void topline(int line) { lineposition(line, TOP); }
  void bottomline(int line) { lineposition(line, BOTTOM); }
  void middleline(int line) { lineposition(line, MIDDLE); }
 
  int select(int line, int val=1);
  int selected(int line) const ;
  void show(int line);
  void show() FL_OVERRIDE { Fl_Widget::show(); }
  void hide(int line);
  void hide() FL_OVERRIDE { Fl_Widget::hide(); }
  int visible(int line) const ;
 
  int value() const ;
  void value(int line) { select(line); }
  const char* text(int line) const ;
  void text(int line, const char* newtext);
  void* data(int line) const ;
  void data(int line, void* d);
 
  Fl_Browser(int X, int Y, int W, int H, const char *L = 0);
  ~Fl_Browser() { clear(); }

  char format_char() const { return format_char_; }
  void format_char(char c) { format_char_ = c; }
  char column_char() const { return column_char_; }
  void column_char(char c) { column_char_ = c; }
  const int* column_widths() const { return column_widths_; }
  void column_widths(const int* arr) { column_widths_ = arr; }

  int displayed(int line) const { return Fl_Browser_::displayed(find_line(line)); }

  void make_visible(int line) {
    if (line < 1) Fl_Browser_::display(find_line(1));
    else if (line > lines) Fl_Browser_::display(find_line(lines));
    else Fl_Browser_::display(find_line(line));
  }
 
  // icon support
  void icon(int line, Fl_Image* icon);
  Fl_Image* icon(int line) const;
  void remove_icon(int line);

  void replace(int a, const char* b) { text(a, b); }
  void display(int line, int val=1);
};
 
#endif