FLTK 1.3.3
fl_draw.H
Go to the documentation of this file.
1 //
2 // "$Id: fl_draw.H 10320 2014-09-18 15:25:55Z greg.ercolano $"
3 //
4 // Portable drawing function header file for the Fast Light Tool Kit (FLTK).
5 //
6 // Copyright 1998-2011 by Bill Spitzak and others.
7 //
8 // This library is free software. Distribution and use rights are outlined in
9 // the file "COPYING" which should have been included with this file. If this
10 // file is missing or damaged, see the license at:
11 //
12 // http://www.fltk.org/COPYING.php
13 //
14 // Please report all bugs and problems on the following page:
15 //
16 // http://www.fltk.org/str.php
17 //
18 
24 #ifndef fl_draw_H
25 #define fl_draw_H
26 
27 #include <FL/x.H> // for Fl_Region
28 #include <FL/Enumerations.H> // for the color names
29 #include <FL/Fl_Window.H> // for fl_set_spot()
30 #include <FL/Fl_Device.H> // for fl_graphics_driver
31 
32 // Image class...
33 class Fl_Image;
34 
35 // Label flags...
36 FL_EXPORT extern char fl_draw_shortcut;
37 
42 // Colors:
52 inline void fl_color(Fl_Color c) {fl_graphics_driver->color(c); } // select indexed color
54 inline void fl_color(int c) {fl_color((Fl_Color)c);}
65 inline void fl_color(uchar r, uchar g, uchar b) {fl_graphics_driver->color(r,g,b); } // select actual color
76 // clip:
82 inline void fl_push_clip(int x, int y, int w, int h) {fl_graphics_driver->push_clip(x,y,w,h); }
91 #define fl_clip fl_push_clip
92 
114 inline int fl_not_clipped(int x, int y, int w, int h) {return fl_graphics_driver->not_clipped(x,y,w,h); }
126 inline int fl_clip_box(int x , int y, int w, int h, int& X, int& Y, int& W, int& H)
127  {return fl_graphics_driver->clip_box(x,y,w,h,X,Y,W,H); }
136 inline void fl_clip_region(Fl_Region r) { fl_graphics_driver->clip_region(r); }
140 inline Fl_Region fl_clip_region() { return fl_graphics_driver->clip_region(); }
141 
142 
143 // points:
147 inline void fl_point(int x, int y) { fl_graphics_driver->point(x,y); }
148 
149 // line type:
177 inline void fl_line_style(int style, int width=0, char* dashes=0) {fl_graphics_driver->line_style(style,width,dashes); }
178 enum {
179  FL_SOLID = 0,
180  FL_DASH = 1,
181  FL_DOT = 2,
184 
185  FL_CAP_FLAT = 0x100,
186  FL_CAP_ROUND = 0x200,
187  FL_CAP_SQUARE = 0x300,
188 
189  FL_JOIN_MITER = 0x1000,
190  FL_JOIN_ROUND = 0x2000,
191  FL_JOIN_BEVEL = 0x3000
192 };
193 
194 // rectangles tweaked to exactly fill the pixel rectangle:
195 
201 inline void fl_rect(int x, int y, int w, int h) { fl_graphics_driver->rect(x,y,w,h); }
202 
204 inline void fl_rect(int x, int y, int w, int h, Fl_Color c) {fl_color(c); fl_rect(x,y,w,h);}
206 inline void fl_rectf(int x, int y, int w, int h) { fl_graphics_driver->rectf(x,y,w,h); }
208 inline void fl_rectf(int x, int y, int w, int h, Fl_Color c) {fl_color(c); fl_rectf(x,y,w,h);}
209 
216 /* note: doxygen comment here to avoid triplication in os-speciic files */
217 FL_EXPORT void fl_rectf(int x, int y, int w, int h, uchar r, uchar g, uchar b);
218 
219 // line segments:
223 inline void fl_line(int x, int y, int x1, int y1) {fl_graphics_driver->line(x,y,x1,y1); }
227 inline void fl_line(int x, int y, int x1, int y1, int x2, int y2) {fl_graphics_driver->line(x,y,x1,y1,x2,y2); }
228 
229 // closed line segments:
233 inline void fl_loop(int x, int y, int x1, int y1, int x2, int y2) {fl_graphics_driver->loop(x,y,x1,y1,x2,y2); }
237 inline void fl_loop(int x, int y, int x1, int y1, int x2, int y2, int x3, int y3)
238  {fl_graphics_driver->loop(x,y,x1,y1,x2,y2,x3,y3); }
239 
240 // filled polygons
244 inline void fl_polygon(int x, int y, int x1, int y1, int x2, int y2) {fl_graphics_driver->polygon(x,y,x1,y1,x2,y2); }
248 inline void fl_polygon(int x, int y, int x1, int y1, int x2, int y2, int x3, int y3)
249  { fl_graphics_driver->polygon(x,y,x1,y1,x2,y2,x3,y3); }
250 
251 // draw rectilinear lines, horizontal segment first:
255 inline void fl_xyline(int x, int y, int x1) {fl_graphics_driver->xyline(x,y,x1);}
259 inline void fl_xyline(int x, int y, int x1, int y2) {fl_graphics_driver->xyline(x,y,x1,y2);}
264 inline void fl_xyline(int x, int y, int x1, int y2, int x3) {fl_graphics_driver->xyline(x,y,x1,y2,x3);}
265 
266 // draw rectilinear lines, vertical segment first:
270 inline void fl_yxline(int x, int y, int y1) {fl_graphics_driver->yxline(x,y,y1);}
274 inline void fl_yxline(int x, int y, int y1, int x2) {fl_graphics_driver->yxline(x,y,y1,x2);}
279 inline void fl_yxline(int x, int y, int y1, int x2, int y3) {fl_graphics_driver->yxline(x,y,y1,x2,y3);}
280 
281 // circular lines and pie slices (code in fl_arci.C):
304 inline void fl_arc(int x, int y, int w, int h, double a1, double a2) {fl_graphics_driver->arc(x,y,w,h,a1,a2); }
317 inline void fl_pie(int x, int y, int w, int h, double a1, double a2) {fl_graphics_driver->pie(x,y,w,h,a1,a2); }
319 FL_EXPORT void fl_chord(int x, int y, int w, int h, double a1, double a2); // nyi
320 
321 // scalable drawing code (code in fl_vertex.C and fl_arc.C):
335 inline void fl_scale(double x, double y) { fl_graphics_driver->scale(x, y); }
340 inline void fl_scale(double x) { fl_graphics_driver->scale(x, x); }
345 inline void fl_translate(double x, double y) { fl_graphics_driver->translate(x, y); }
350 inline void fl_rotate(double d) { fl_graphics_driver->rotate(d); }
357 inline void fl_mult_matrix(double a, double b, double c, double d, double x,double y)
358  { fl_graphics_driver->mult_matrix(a, b, c, d, x, y); }
379 inline void fl_vertex(double x, double y) {fl_graphics_driver->vertex(x,y); }
388 inline void fl_curve(double X0, double Y0, double X1, double Y1, double X2, double Y2, double X3, double Y3)
389  {fl_graphics_driver->curve(X0,Y0,X1,Y1,X2,Y2,X3,Y3); }
416 inline void fl_arc(double x, double y, double r, double start, double end) {fl_graphics_driver->arc(x,y,r,start,end); }
424 inline void fl_circle(double x, double y, double r) {fl_graphics_driver->circle(x,y,r); }
462 inline void fl_gap() {fl_graphics_driver->gap(); }
467 // get and use transformed positions:
472 inline double fl_transform_x(double x, double y) {return fl_graphics_driver->transform_x(x, y); }
477 inline double fl_transform_y(double x, double y) {return fl_graphics_driver->transform_y(x, y); }
482 inline double fl_transform_dx(double x, double y) {return fl_graphics_driver->transform_dx(x, y); }
487 inline double fl_transform_dy(double x, double y) {return fl_graphics_driver->transform_dy(x, y); }
492 inline void fl_transformed_vertex(double xf, double yf) {fl_graphics_driver->transformed_vertex(xf,yf); }
497 /* NOTE: doxygen comments here to avoid triplication in os-specific sources */
498 
499 // Fonts:
509 inline void fl_font(Fl_Font face, Fl_Fontsize fsize) { fl_graphics_driver->font(face,fsize); }
510 
515 inline Fl_Font fl_font() {return fl_graphics_driver->font();}
521 
522 // information you can get about the current font:
527 inline int fl_height() {return fl_graphics_driver->height();}
528 FL_EXPORT int fl_height(int font, int size);
533 inline int fl_descent() {return fl_graphics_driver->descent();}
536 FL_EXPORT double fl_width(const char* txt);
539 inline double fl_width(const char* txt, int n) {return fl_graphics_driver->width(txt, n);}
544 inline double fl_width(unsigned int c) {return fl_graphics_driver->width(c);}
555 FL_EXPORT void fl_text_extents(const char*, int& dx, int& dy, int& w, int& h); // NO fltk symbol expansion will be performed
559 inline void fl_text_extents(const char *t, int n, int& dx, int& dy, int& w, int& h)
560  {fl_graphics_driver->text_extents(t, n, dx, dy, w, h);}
561 
562 // font encoding:
563 // Note: doxygen comments here to avoid duplication for os-sepecific cases
570 FL_EXPORT const char *fl_latin1_to_local(const char *t, int n=-1);
577 FL_EXPORT const char *fl_local_to_latin1(const char *t, int n=-1);
584 FL_EXPORT const char *fl_mac_roman_to_local(const char *t, int n=-1);
591 FL_EXPORT const char *fl_local_to_mac_roman(const char *t, int n=-1);
606 FL_EXPORT void fl_draw(const char* str, int x, int y);
614 FL_EXPORT void fl_draw(int angle, const char* str, int x, int y);
618 inline void fl_draw(const char* str, int n, int x, int y) {fl_graphics_driver->draw(str,n,x,y); }
623 inline void fl_draw(int angle, const char* str, int n, int x, int y) {fl_graphics_driver->draw(angle,str,n,x,y); }
627 inline void fl_rtl_draw(const char* str, int n, int x, int y) {fl_graphics_driver->rtl_draw(str,n,x,y); }
628 FL_EXPORT void fl_measure(const char* str, int& x, int& y,
629  int draw_symbols = 1);
630 FL_EXPORT void fl_draw(const char* str, int x, int y, int w, int h,
631  Fl_Align align,
632  Fl_Image* img=0, int draw_symbols = 1);
633 FL_EXPORT void fl_draw(const char* str, int x, int y, int w, int h,
634  Fl_Align align,
635  void (*callthis)(const char *,int,int,int),
636  Fl_Image* img=0, int draw_symbols = 1);
637 
638 // boxtypes:
639 FL_EXPORT void fl_frame(const char* s, int x, int y, int w, int h);
640 FL_EXPORT void fl_frame2(const char* s, int x, int y, int w, int h);
641 FL_EXPORT void fl_draw_box(Fl_Boxtype, int x, int y, int w, int h, Fl_Color);
642 
643 // images:
644 
680 inline void fl_draw_image(const uchar* buf, int X,int Y,int W,int H, int D=3, int L=0)
681  { fl_graphics_driver->draw_image(buf, X, Y, W, H, D, L); }
682 
687 inline void fl_draw_image_mono(const uchar* buf, int X,int Y,int W,int H, int D=1, int L=0)
688  { fl_graphics_driver->draw_image_mono(buf, X, Y, W, H, D, L); }
689 
723 inline void fl_draw_image(Fl_Draw_Image_Cb cb, void* data, int X,int Y,int W,int H, int D=3)
724  { fl_graphics_driver->draw_image(cb, data, X, Y, W, H, D); }
725 
730 inline void fl_draw_image_mono(Fl_Draw_Image_Cb cb, void* data, int X,int Y,int W,int H, int D=1)
731  { fl_graphics_driver->draw_image_mono(cb, data, X, Y, W, H, D); }
732 
738 /* note: doxygen comment here to avoid triplication in os-speciic files */
739 FL_EXPORT char fl_can_do_alpha_blending();
740 
758 /* note: doxygen comment here to avoid triplication in os-speciic files */
759 FL_EXPORT uchar *fl_read_image(uchar *p,int X,int Y,int W,int H,int alpha=0);
760 
761 // pixmaps:
762 FL_EXPORT int fl_draw_pixmap(/*const*/ char* const* data, int x,int y,Fl_Color=FL_GRAY);
763 FL_EXPORT int fl_draw_pixmap(const char* const* cdata, int x,int y,Fl_Color=FL_GRAY);
764 FL_EXPORT int fl_measure_pixmap(/*const*/ char* const* data, int &w, int &h);
765 FL_EXPORT int fl_measure_pixmap(const char* const* cdata, int &w, int &h);
766 
767 // other:
768 FL_EXPORT void fl_scroll(int X, int Y, int W, int H, int dx, int dy,
769  void (*draw_area)(void*, int,int,int,int), void* data);
770 FL_EXPORT const char* fl_shortcut_label(unsigned int shortcut);
771 FL_EXPORT const char* fl_shortcut_label(unsigned int shortcut, const char **eom);
772 FL_EXPORT unsigned int fl_old_shortcut(const char* s);
773 FL_EXPORT void fl_overlay_rect(int x,int y,int w,int h);
774 FL_EXPORT void fl_overlay_clear();
775 FL_EXPORT void fl_cursor(Fl_Cursor);
776 FL_EXPORT void fl_cursor(Fl_Cursor, Fl_Color fg, Fl_Color bg=FL_WHITE);
777 FL_EXPORT const char* fl_expand_text(const char* from, char* buf, int maxbuf,
778  double maxw, int& n, double &width,
779  int wrap, int draw_symbols = 0);
780 
781 // XIM:
783 FL_EXPORT void fl_set_status(int X, int Y, int W, int H);
785 FL_EXPORT void fl_set_spot(int font, int size, int X, int Y, int W, int H, Fl_Window *win=0);
787 FL_EXPORT void fl_reset_spot(void);
788 
789 
790 
791 // XForms symbols:
792 FL_EXPORT int fl_draw_symbol(const char* label,int x,int y,int w,int h, Fl_Color);
793 FL_EXPORT int fl_add_symbol(const char* name, void (*drawit)(Fl_Color), int scalable);
796 #endif
797 
798 //
799 // End of "$Id: fl_draw.H 10320 2014-09-18 15:25:55Z greg.ercolano $".
800 //