FLTK 1.4.0
Fl_Chart Class Reference

Fl_Chart displays simple charts. More...

#include <Fl_Chart.H>

Inheritance diagram for Fl_Chart:
Fl_Widget

Public Member Functions

void add (double val, const char *str=0, unsigned col=0)
 Adds the data value val with optional label str and color col to the chart. More...
 
uchar autosize () const
 Gets whether the chart will automatically adjust the bounds of the chart. More...
 
void autosize (uchar n)
 Sets whether the chart will automatically adjust the bounds of the chart. More...
 
void bounds (double *a, double *b) const
 Gets the lower and upper bounds of the chart values. More...
 
void bounds (double a, double b)
 Sets the lower and upper bounds of the chart values. More...
 
void clear ()
 Removes all values from the chart.
 
 Fl_Chart (int X, int Y, int W, int H, const char *L=0)
 Create a new Fl_Chart widget using the given position, size and label string. More...
 
void insert (int ind, double val, const char *str=0, unsigned col=0)
 Inserts a data value val at the given position ind. More...
 
int maxsize () const
 Gets the maximum number of data values for a chart.
 
void maxsize (int m)
 Sets the maximum number of data values for a chart. More...
 
void replace (int ind, double val, const char *str=0, unsigned col=0)
 Replaces a data value val at the given position ind. More...
 
int size () const
 Returns the number of data values in the chart.
 
void size (int W, int H)
 Sets the widget size (width, height). More...
 
Fl_Color textcolor () const
 Gets the chart's text color.
 
void textcolor (Fl_Color n)
 Sets the chart's text color to n.
 
Fl_Font textfont () const
 Gets the chart's text font.
 
void textfont (Fl_Font s)
 Sets the chart's text font to s.
 
Fl_Fontsize textsize () const
 Gets the chart's text size.
 
void textsize (Fl_Fontsize s)
 Sets the chart's text size to s.
 
 ~Fl_Chart ()
 Destroys the Fl_Chart widget and all of its data.
 
- Public Member Functions inherited from Fl_Widget
void _clear_fullscreen ()
 
void _set_fullscreen ()
 
void activate ()
 Activates the widget. More...
 
unsigned int active () const
 Returns whether the widget is active. More...
 
int active_r () const
 Returns whether the widget and all of its parents are active. More...
 
Fl_Align align () const
 Gets the label alignment. More...
 
void align (Fl_Align alignment)
 Sets the label alignment. More...
 
long argument () const
 Gets the current user data (long) argument that is passed to the callback function. More...
 
void argument (long v)
 Sets the current user data (long) argument that is passed to the callback function. More...
 
virtual class Fl_Gl_Windowas_gl_window ()
 Returns an Fl_Gl_Window pointer if this widget is an Fl_Gl_Window. More...
 
virtual Fl_Groupas_group ()
 Returns an Fl_Group pointer if this widget is an Fl_Group. More...
 
virtual Fl_Windowas_window ()
 Returns an Fl_Window pointer if this widget is an Fl_Window. More...
 
void bind_deimage (Fl_Image *img)
 Sets the image to use as part of the widget label when in the inactive state. More...
 
void bind_deimage (int f)
 Bind the inactive image to the widget, so the widget will delete the image when it is no longer needed. More...
 
void bind_image (Fl_Image *img)
 Sets the image to use as part of the widget label when in the active state. More...
 
void bind_image (int f)
 Bind the image to the widget, so the widget will delete the image when it is no longer needed. More...
 
Fl_Boxtype box () const
 Gets the box type of the widget. More...
 
void box (Fl_Boxtype new_box)
 Sets the box type for the widget. More...
 
Fl_Callback_p callback () const
 Gets the current callback function for the widget. More...
 
void callback (Fl_Callback *cb)
 Sets the current callback function for the widget. More...
 
void callback (Fl_Callback *cb, void *p)
 Sets the current callback function for the widget. More...
 
void callback (Fl_Callback0 *cb)
 Sets the current callback function for the widget. More...
 
void callback (Fl_Callback1 *cb, long p=0)
 Sets the current callback function for the widget. More...
 
unsigned int changed () const
 Checks if the widget value changed since the last callback. More...
 
void clear_active ()
 Marks the widget as inactive without sending events or changing focus. More...
 
void clear_changed ()
 Marks the value of the widget as unchanged. More...
 
void clear_damage (uchar c=0)
 Clears or sets the damage flags. More...
 
void clear_output ()
 Sets a widget to accept input. More...
 
void clear_visible ()
 Hides the widget. More...
 
void clear_visible_focus ()
 Disables keyboard focus navigation with this widget. More...
 
Fl_Color color () const
 Gets the background color of the widget. More...
 
void color (Fl_Color bg)
 Sets the background color of the widget. More...
 
void color (Fl_Color bg, Fl_Color sel)
 Sets the background and selection color of the widget. More...
 
Fl_Color color2 () const
 For back compatibility only. More...
 
void color2 (unsigned a)
 For back compatibility only. More...
 
int contains (const Fl_Widget *w) const
 Checks if w is a child of this widget. More...
 
void copy_label (const char *new_label)
 Sets the current label. More...
 
void copy_tooltip (const char *text)
 Sets the current tooltip text. More...
 
uchar damage () const
 Returns non-zero if draw() needs to be called. More...
 
void damage (uchar c)
 Sets the damage bits for the widget. More...
 
void damage (uchar c, int x, int y, int w, int h)
 Sets the damage bits for an area inside the widget. More...
 
int damage_resize (int, int, int, int)
 Internal use only.
 
void deactivate ()
 Deactivates the widget. More...
 
Fl_Imagedeimage ()
 Gets the image that is used as part of the widget label when in the inactive state. More...
 
const Fl_Imagedeimage () const
 Gets the image that is used as part of the widget label when in the inactive state. More...
 
void deimage (Fl_Image &img)
 Sets the image to use as part of the widget label when in the inactive state. More...
 
void deimage (Fl_Image *img)
 Sets the image to use as part of the widget label when in the inactive state. More...
 
int deimage_bound () const
 Returns whether the inactive image is managed by the widget. More...
 
void do_callback (Fl_Callback_Reason reason=FL_REASON_UNKNOWN)
 Calls the widget callback function with default arguments. More...
 
void do_callback (Fl_Widget *widget, long arg, Fl_Callback_Reason reason=FL_REASON_UNKNOWN)
 Calls the widget callback function with arbitrary arguments. More...
 
void do_callback (Fl_Widget *widget, void *arg=0, Fl_Callback_Reason reason=FL_REASON_UNKNOWN)
 Calls the widget callback function with arbitrary arguments. More...
 
void draw_label (int, int, int, int, Fl_Align) const
 Draws the label in an arbitrary bounding box with an arbitrary alignment. More...
 
int h () const
 Gets the widget height. More...
 
virtual int handle (int event)
 Handles the specified event. More...
 
virtual void hide ()
 Makes a widget invisible. More...
 
Fl_Imageimage ()
 Gets the image that is used as part of the widget label when in the active state. More...
 
const Fl_Imageimage () const
 Gets the image that is used as part of the widget label when in the active state. More...
 
void image (Fl_Image &img)
 Sets the image to use as part of the widget label when in the active state. More...
 
void image (Fl_Image *img)
 Sets the image to use as part of the widget label when in the active state. More...
 
int image_bound () const
 Returns whether the image is managed by the widget. More...
 
int inside (const Fl_Widget *wgt) const
 Checks if this widget is a child of wgt. More...
 
int is_label_copied () const
 Returns whether the current label was assigned with copy_label(). More...
 
const char * label () const
 Gets the current label text. More...
 
void label (const char *text)
 Sets the current label pointer. More...
 
void label (Fl_Labeltype a, const char *b)
 Shortcut to set the label text and type in one call. More...
 
Fl_Color labelcolor () const
 Gets the label color. More...
 
void labelcolor (Fl_Color c)
 Sets the label color. More...
 
Fl_Font labelfont () const
 Gets the font to use. More...
 
void labelfont (Fl_Font f)
 Sets the font to use. More...
 
Fl_Fontsize labelsize () const
 Gets the font size in pixels. More...
 
void labelsize (Fl_Fontsize pix)
 Sets the font size in pixels. More...
 
Fl_Labeltype labeltype () const
 Gets the label type. More...
 
void labeltype (Fl_Labeltype a)
 Sets the label type. More...
 
void measure_label (int &ww, int &hh) const
 Sets width ww and height hh accordingly with the label size. More...
 
unsigned int output () const
 Returns if a widget is used for output only. More...
 
Fl_Groupparent () const
 Returns a pointer to the parent widget. More...
 
void parent (Fl_Group *p)
 Internal use only - "for hacks only". More...
 
void position (int X, int Y)
 Repositions the window or widget. More...
 
void redraw ()
 Schedules the drawing of the widget. More...
 
void redraw_label ()
 Schedules the drawing of the label. More...
 
virtual void resize (int x, int y, int w, int h)
 Changes the size or position of the widget. More...
 
Fl_Color selection_color () const
 Gets the selection color. More...
 
void selection_color (Fl_Color a)
 Sets the selection color. More...
 
void set_active ()
 Marks the widget as active without sending events or changing focus. More...
 
void set_changed ()
 Marks the value of the widget as changed. More...
 
void set_output ()
 Sets a widget to output only. More...
 
void set_visible ()
 Makes the widget visible. More...
 
void set_visible_focus ()
 Enables keyboard focus navigation with this widget. More...
 
int shortcut_label () const
 Returns whether the widget's label uses '&' to indicate shortcuts. More...
 
void shortcut_label (int value)
 Sets whether the widget's label uses '&' to indicate shortcuts. More...
 
virtual void show ()
 Makes a widget visible. More...
 
void size (int W, int H)
 Changes the size of the widget. More...
 
int take_focus ()
 Gives the widget the keyboard focus. More...
 
unsigned int takesevents () const
 Returns if the widget is able to take events. More...
 
int test_shortcut ()
 Returns true if the widget's label contains the entered '&x' shortcut. More...
 
const char * tooltip () const
 Gets the current tooltip text. More...
 
void tooltip (const char *text)
 Sets the current tooltip text. More...
 
Fl_Windowtop_window () const
 Returns a pointer to the top-level window for the widget. More...
 
Fl_Windowtop_window_offset (int &xoff, int &yoff) const
 Finds the x/y offset of the current widget relative to the top-level window. More...
 
uchar type () const
 Gets the widget type. More...
 
void type (uchar t)
 Sets the widget type. More...
 
int use_accents_menu ()
 Returns non zero if MAC_USE_ACCENTS_MENU flag is set, 0 otherwise.
 
void * user_data () const
 Gets the user data for this widget. More...
 
void user_data (void *v)
 Sets the user data for this widget. More...
 
unsigned int visible () const
 Returns whether a widget is visible. More...
 
unsigned int visible_focus () const
 Checks whether this widget has a visible focus. More...
 
void visible_focus (int v)
 Modifies keyboard focus navigation. More...
 
int visible_r () const
 Returns whether a widget and all its parents are visible. More...
 
int w () const
 Gets the widget width. More...
 
Fl_When when () const
 Returns the conditions under which the callback is called. More...
 
void when (uchar i)
 Sets the flags used to decide when a callback is called. More...
 
Fl_Windowwindow () const
 Returns a pointer to the nearest parent window up the widget hierarchy. More...
 
int x () const
 Gets the widget position in its window. More...
 
int y () const
 Gets the widget position in its window. More...
 
virtual ~Fl_Widget ()
 Destroys the widget. More...
 

Protected Member Functions

void draw () FL_OVERRIDE
 Draws the Fl_Chart widget.
 
- Protected Member Functions inherited from Fl_Widget
void clear_flag (unsigned int c)
 Clears a flag in the flags mask.
 
void draw_backdrop () const
 If FL_ALIGN_IMAGE_BACKDROP is set, the image or deimage will be drawn.
 
void draw_box () const
 Draws the widget box according its box style.
 
void draw_box (Fl_Boxtype t, Fl_Color c) const
 Draws a box of type t, of color c at the widget's position and size.
 
void draw_box (Fl_Boxtype t, int x, int y, int w, int h, Fl_Color c) const
 Draws a box of type t, of color c at the position X,Y and size W,H.
 
void draw_focus () const
 Draws a focus rectangle around the widget. More...
 
void draw_focus (Fl_Boxtype t, int X, int Y, int W, int H) const
 Draws a focus rectangle around the widget. More...
 
void draw_focus (Fl_Boxtype t, int x, int y, int w, int h, Fl_Color bg) const
 Draws a focus box for the widget at the given position and size. More...
 
void draw_label () const
 Draws the widget's label at the defined label position. More...
 
void draw_label (int, int, int, int) const
 Draws the label in an arbitrary bounding box. More...
 
 Fl_Widget (int x, int y, int w, int h, const char *label=0L)
 Creates a widget at the given position and size. More...
 
unsigned int flags () const
 Gets the widget flags mask.
 
void h (int v)
 Internal use only. More...
 
void set_flag (unsigned int c)
 Sets a flag in the flags mask.
 
void w (int v)
 Internal use only. More...
 
void x (int v)
 Internal use only. More...
 
void y (int v)
 Internal use only. More...
 

Static Protected Member Functions

static void draw_barchart (int x, int y, int w, int h, int numb, FL_CHART_ENTRY entries[], double min, double max, int autosize, int maxnumb, Fl_Color textcolor)
 Draws a bar chart. More...
 
static void draw_horbarchart (int x, int y, int w, int h, int numb, FL_CHART_ENTRY entries[], double min, double max, int autosize, int maxnumb, Fl_Color textcolor)
 Draws a horizontal bar chart. More...
 
static void draw_linechart (int type, int x, int y, int w, int h, int numb, FL_CHART_ENTRY entries[], double min, double max, int autosize, int maxnumb, Fl_Color textcolor)
 Draws a line chart. More...
 
static void draw_piechart (int x, int y, int w, int h, int numb, FL_CHART_ENTRY entries[], int special, Fl_Color textcolor)
 Draws a pie chart. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Fl_Widget
static void default_callback (Fl_Widget *widget, void *data)
 The default callback for all widgets that don't set a callback. More...
 
static unsigned int label_shortcut (const char *t)
 Returns the Unicode value of the '&x' shortcut in a given text. More...
 
static int test_shortcut (const char *, const bool require_alt=false)
 Returns true if the given text t contains the entered '&x' shortcut. More...
 
- Protected Types inherited from Fl_Widget
enum  {
  INACTIVE = 1<<0 , INVISIBLE = 1<<1 , OUTPUT = 1<<2 , NOBORDER = 1<<3 ,
  FORCE_POSITION = 1<<4 , NON_MODAL = 1<<5 , SHORTCUT_LABEL = 1<<6 , CHANGED = 1<<7 ,
  OVERRIDE = 1<<8 , VISIBLE_FOCUS = 1<<9 , COPIED_LABEL = 1<<10 , CLIP_CHILDREN = 1<<11 ,
  MENU_WINDOW = 1<<12 , TOOLTIP_WINDOW = 1<<13 , MODAL = 1<<14 , NO_OVERLAY = 1<<15 ,
  GROUP_RELATIVE = 1<<16 , COPIED_TOOLTIP = 1<<17 , FULLSCREEN = 1<<18 , MAC_USE_ACCENTS_MENU = 1<<19 ,
  NEEDS_KEYBOARD = 1<<20 , IMAGE_BOUND = 1<<21 , DEIMAGE_BOUND = 1<<22 , USERFLAG3 = 1<<29 ,
  USERFLAG2 = 1<<30 , USERFLAG1 = 1<<31
}
 flags possible values enumeration. More...
 

Detailed Description

Fl_Chart displays simple charts.

It is provided for Forms compatibility.

Todo:
Refactor Fl_Chart::type() information.

The type of an Fl_Chart object can be set using type(uchar t) to:

Chart Type Description
FL_BAR_CHART Each sample value is drawn as a vertical bar.
FL_FILLED_CHART The chart is filled from the bottom of the graph to the sample values.
FL_HORBAR_CHART Each sample value is drawn as a horizontal bar.
FL_LINE_CHART The chart is drawn as a polyline with vertices at each sample value.
FL_PIE_CHART A pie chart is drawn with each sample value being drawn as a proportionate slice in the circle.
FL_SPECIALPIE_CHART Like FL_PIE_CHART, but the first slice is separated from the pie.
FL_SPIKE_CHART Each sample value is drawn as a vertical line.

Constructor & Destructor Documentation

◆ Fl_Chart()

Fl_Chart::Fl_Chart ( int  X,
int  Y,
int  W,
int  H,
const char *  L = 0 
)

Create a new Fl_Chart widget using the given position, size and label string.

The default boxstyle is FL_NO_BOX.

Parameters
[in]X,Y,W,Hposition and size of the widget
[in]Lwidget label, default is no label

Member Function Documentation

◆ add()

void Fl_Chart::add ( double  val,
const char *  str = 0,
unsigned  col = 0 
)

Adds the data value val with optional label str and color col to the chart.

Parameters
[in]valdata value
[in]stroptional data label
[in]coloptional data color

◆ autosize() [1/2]

uchar Fl_Chart::autosize ( ) const
inline

Gets whether the chart will automatically adjust the bounds of the chart.

Returns
non-zero if auto-sizing is enabled and zero if disabled.

◆ autosize() [2/2]

void Fl_Chart::autosize ( uchar  n)
inline

Sets whether the chart will automatically adjust the bounds of the chart.

Parameters
[in]nnon-zero to enable automatic resizing, zero to disable.

◆ bounds() [1/2]

void Fl_Chart::bounds ( double *  a,
double *  b 
) const
inline

Gets the lower and upper bounds of the chart values.

Parameters
[out]a,bare set to lower, upper

◆ bounds() [2/2]

void Fl_Chart::bounds ( double  a,
double  b 
)

Sets the lower and upper bounds of the chart values.

Parameters
[in]a,bare used to set lower, upper

◆ draw_barchart()

void Fl_Chart::draw_barchart ( int  x,
int  y,
int  w,
int  h,
int  numb,
FL_CHART_ENTRY  entries[],
double  min,
double  max,
int  autosize,
int  maxnumb,
Fl_Color  textcolor 
)
staticprotected

Draws a bar chart.

x, y, w, h is the bounding box, entries the array of numb entries, and min and max the boundaries.

Parameters
[in]x,y,w,hWidget position and size
[in]numbNumber of values
[in]entriesArray of values
[in]minLower boundary
[in]maxUpper boundary
[in]autosizeWhether the chart autosizes
[in]maxnumbMaximal number of entries
[in]textcolorText color

◆ draw_horbarchart()

void Fl_Chart::draw_horbarchart ( int  x,
int  y,
int  w,
int  h,
int  numb,
FL_CHART_ENTRY  entries[],
double  min,
double  max,
int  autosize,
int  maxnumb,
Fl_Color  textcolor 
)
staticprotected

Draws a horizontal bar chart.

x, y, w, h is the bounding box, entries the array of numb entries, and min and max the boundaries.

Parameters
[in]x,y,w,hWidget position and size
[in]numbNumber of values
[in]entriesArray of values
[in]minLower boundary
[in]maxUpper boundary
[in]autosizeWhether the chart autosizes
[in]maxnumbMaximal number of entries
[in]textcolorText color

◆ draw_linechart()

void Fl_Chart::draw_linechart ( int  type,
int  x,
int  y,
int  w,
int  h,
int  numb,
FL_CHART_ENTRY  entries[],
double  min,
double  max,
int  autosize,
int  maxnumb,
Fl_Color  textcolor 
)
staticprotected

Draws a line chart.

x, y, w, h is the bounding box, entries the array of numb entries, and min and max the boundaries.

Parameters
[in]typeChart type
[in]x,y,w,hWidget position and size
[in]numbNumber of values
[in]entriesArray of values
[in]minLower boundary
[in]maxUpper boundary
[in]autosizeWhether the chart autosizes
[in]maxnumbMaximal number of entries
[in]textcolorText color

◆ draw_piechart()

void Fl_Chart::draw_piechart ( int  x,
int  y,
int  w,
int  h,
int  numb,
FL_CHART_ENTRY  entries[],
int  special,
Fl_Color  textcolor 
)
staticprotected

Draws a pie chart.

Parameters
[in]x,y,w,hbounding box
[in]numbnumber of chart entries
[in]entriesarray of chart entries
[in]specialspecial (?)
[in]textcolortext color

◆ insert()

void Fl_Chart::insert ( int  ind,
double  val,
const char *  str = 0,
unsigned  col = 0 
)

Inserts a data value val at the given position ind.

Position 1 is the first data value.

Parameters
[in]indinsertion position
[in]valdata value
[in]stroptional data label
[in]coloptional data color

◆ maxsize()

void Fl_Chart::maxsize ( int  m)

Sets the maximum number of data values for a chart.

If you do not call this method then the chart will be allowed to grow to any size depending on available memory.

Parameters
[in]mmaximum number of data values allowed.

◆ replace()

void Fl_Chart::replace ( int  ind,
double  val,
const char *  str = 0,
unsigned  col = 0 
)

Replaces a data value val at the given position ind.

Position 1 is the first data value.

Parameters
[in]indinsertion position
[in]valdata value
[in]stroptional data label
[in]coloptional data color

◆ size()

void Fl_Chart::size ( int  W,
int  H 
)
inline

Sets the widget size (width, height).

This is the same as calling Fl_Widget::size(int W, int H);

Parameters
[in]W,Hnew width and height of the widget

The documentation for this class was generated from the following files: