fltk/FL/Fl_Positioner.H
Fabien Costantini ce4d0fd5d8 Doxygen Documentation WP4 Done. Has all documentation content but should be completed in increment 2. Registered for WP5.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6239 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 15:45:27 +00:00

100 lines
3.0 KiB
C++

//
// "$Id$"
//
// Positioner header file for the Fast Light Tool Kit (FLTK).
//
// Copyright 1998-2005 by Bill Spitzak and others.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Library General Public
// License as published by the Free Software Foundation; either
// version 2 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Library General Public License for more details.
//
// You should have received a copy of the GNU Library General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA.
//
// Please report all bugs and problems on the following page:
//
// http://www.fltk.org/str.php
//
#ifndef Fl_Positioner_H
#define Fl_Positioner_H
#ifndef Fl_Widget_H
#include "Fl_Widget.H"
#endif
/**
This class is provided for Forms compatibility. It provides 2D input.
It would be useful if this could be put atop another widget so that the
crosshairs are on top, but this is not implemented. The color of the
crosshairs is selection_color().
<P ALIGN=CENTER>\image html src=
*/
class FL_EXPORT Fl_Positioner : public Fl_Widget {
double xmin, ymin;
double xmax, ymax;
double xvalue_, yvalue_;
double xstep_, ystep_;
protected:
// these allow subclasses to put the dial in a smaller area:
void draw(int, int, int, int);
int handle(int, int, int, int, int);
void draw();
public:
int handle(int);
/**
Creates a new Fl_Positioner widget using the given position,
size, and label string. The default boxtype is FL_NO_BOX.
*/
Fl_Positioner(int x,int y,int w,int h, const char *l=0);
/** Gets the X axis coordinate.*/
double xvalue() const {return xvalue_;}
/** Gets the Y axis coordinate.*/
double yvalue() const {return yvalue_;}
int xvalue(double);
int yvalue(double);
int value(double,double);
void xbounds(double, double);
/** Gets the X axis minimum */
double xminimum() const {return xmin;}
/** Same as xbounds(a, xmaximum()) */
void xminimum(double a) {xbounds(a,xmax);}
/** Gets the X axis maximum */
double xmaximum() const {return xmax;}
/** Same as xbounds(xminimum(), a) */
void xmaximum(double a) {xbounds(xmin,a);}
void ybounds(double, double);
/** Gets the Y axis minimum */
double yminimum() const {return ymin;}
/** Same as ybounds(a, ymaximum()) */
void yminimum(double a) {ybounds(a, ymax);}
/** Gets the Y axis maximum */
double ymaximum() const {return ymax;}
/** Same as ybounds(ymininimum(), a) */
void ymaximum(double a) {ybounds(ymin, a);}
/** Sets the stepping value for the X axis.*/
void xstep(double a) {xstep_ = a;}
/** Sets the stepping value for the Y axis.*/
void ystep(double a) {ystep_ = a;}
};
#endif
//
// End of "$Id$".
//