Improve Fl_Cairo_Window documentation (typos + indentation)
Also fix a doxygen warning in Fl_String.
This commit is contained in:
parent
b98aa7bee6
commit
aebf2fec39
@ -1,5 +1,5 @@
|
|||||||
//
|
//
|
||||||
// Cairo window header file for the Fast Light Tool Kit (FLTK).
|
// Fl_Cairo_Window header file for the Fast Light Tool Kit (FLTK).
|
||||||
//
|
//
|
||||||
// Copyright 1998-2023 by Bill Spitzak and others.
|
// Copyright 1998-2023 by Bill Spitzak and others.
|
||||||
//
|
//
|
||||||
@ -14,8 +14,8 @@
|
|||||||
// https://www.fltk.org/bugs.php
|
// https://www.fltk.org/bugs.php
|
||||||
//
|
//
|
||||||
|
|
||||||
/* \file
|
/** \file FL/Fl_Cairo_Window.H
|
||||||
Fl_Cairo_Window, an FLTK window incorporating a Cairo draw callback.
|
\brief Fl_Cairo_Window, an FLTK window incorporating a Cairo draw callback.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef FL_CAIRO_WINDOW_H
|
#ifndef FL_CAIRO_WINDOW_H
|
||||||
@ -27,6 +27,7 @@
|
|||||||
|
|
||||||
// Cairo is currently supported for the following platforms:
|
// Cairo is currently supported for the following platforms:
|
||||||
// Win32, Apple Quartz, X11, Wayland
|
// Win32, Apple Quartz, X11, Wayland
|
||||||
|
|
||||||
# include <FL/Fl.H>
|
# include <FL/Fl.H>
|
||||||
# include <FL/Fl_Double_Window.H>
|
# include <FL/Fl_Double_Window.H>
|
||||||
|
|
||||||
@ -42,47 +43,48 @@
|
|||||||
so that the only thing you have to do is to provide your Cairo code.
|
so that the only thing you have to do is to provide your Cairo code.
|
||||||
All Cairo context handling is achieved transparently.
|
All Cairo context handling is achieved transparently.
|
||||||
|
|
||||||
The default coordinate system for cairo drawing commands within Fl_Cario_Window
|
The default coordinate system for Cairo drawing commands within Fl_Cairo_Window
|
||||||
is FLTK's coordinate system, where the `x,y,w,h` values are releative to the
|
is FLTK's coordinate system, where the `x,y,w,h` values are relative to the
|
||||||
top/left corner of the Fl_Cairo_Window, as one would expect with regular
|
top/left corner of the Fl_Cairo_Window, as one would expect with regular
|
||||||
FLTK drawing commands, e.g.: `(0≤x≤w-1),(0≤y≤h-1)`. \b Example:
|
FLTK drawing commands, e.g.: `(0 ≤ x ≤ w-1), (0 ≤ y ≤ h-1)`.
|
||||||
\code
|
\b Example:
|
||||||
static void my_cairo_draw_cb(Fl_Cairo_Window *window, cairo_t *cr) {
|
\code
|
||||||
// Draw an "X"
|
static void my_cairo_draw_cb(Fl_Cairo_Window *window, cairo_t *cr) {
|
||||||
const double xmax = (window->w() - 1);
|
// Draw an "X"
|
||||||
const double ymax = (window->h() - 1);
|
const double xmax = (window->w() - 1);
|
||||||
cairo_set_line_width(cr, 1.00); // line width for drawing
|
const double ymax = (window->h() - 1);
|
||||||
cairo_set_source_rgb(cr, 1.0, 0.5, 0.0); // orange
|
cairo_set_line_width(cr, 1.00); // line width for drawing
|
||||||
cairo_move_to(cr, 0.0, 0.0); cairo_line_to(cr, xmax, ymax); // draw diagonal "\"
|
cairo_set_source_rgb(cr, 1.0, 0.5, 0.0); // orange
|
||||||
cairo_move_to(cr, 0.0, ymax); cairo_line_to(cr, xmax, 0.0); // draw diagonal "/"
|
cairo_move_to(cr, 0.0, 0.0); cairo_line_to(cr, xmax, ymax); // draw diagonal "\"
|
||||||
cairo_stroke(cr); // stroke the lines
|
cairo_move_to(cr, 0.0, ymax); cairo_line_to(cr, xmax, 0.0); // draw diagonal "/"
|
||||||
}
|
cairo_stroke(cr); // stroke the lines
|
||||||
\endcode
|
}
|
||||||
|
\endcode
|
||||||
|
|
||||||
The FLTK coordinate system differs from the default native cairo coordinate system
|
The FLTK coordinate system differs from the default native Cairo coordinate system
|
||||||
which uses normalized `(0.0…1.0)` values for x and y, e.g.: `(0≤x≤1.0),(0≤y≤1.0)`.
|
which uses normalized `(0.0 … 1.0)` values for x and y, e.g.: `(0 ≤ x ≤ 1.0), (0 ≤ y ≤ 1.0)`.
|
||||||
So beware of this when copy/pasting cairo example programs that assume normalized values.
|
So beware of this when copy/pasting Cairo example programs that assume normalized values.
|
||||||
If need be, you can revert to the cairo coordinate system by simply calling `cairo_scale()`
|
If need be, you can revert to the Cairo coordinate system by simply calling `cairo_scale()`
|
||||||
with the widget's `w()` and `h()` values. \b Example:
|
with the widget's `w()` and `h()` values. \b Example:
|
||||||
|
|
||||||
\code
|
\code
|
||||||
static void my_cairo_draw_cb(Fl_Cairo_Window *window, cairo_t *cr) {
|
static void my_cairo_draw_cb(Fl_Cairo_Window *window, cairo_t *cr) {
|
||||||
cairo_scale(cr, window->w(), window->h()); // use cairo's default coordinate system
|
cairo_scale(cr, window->w(), window->h()); // use Cairo's default coordinate system
|
||||||
[..use 0.0 to 1.0 values from here on..]
|
[..use 0.0 to 1.0 values from here on..]
|
||||||
}
|
}
|
||||||
\endcode
|
\endcode
|
||||||
|
|
||||||
\see examples/cairo-draw-x.cxx
|
\see examples/cairo-draw-x.cxx
|
||||||
\see test/cairo_test.cxx
|
\see test/cairo_test.cxx
|
||||||
|
|
||||||
\note Class Fl_Cairo_Window requires the FLTK library to have been built with
|
\note Class Fl_Cairo_Window requires the FLTK library to have been built with
|
||||||
CMake option OPTION_CAIRO or configure --enable-cairo.
|
CMake option OPTION_CAIRO or configure --enable-cairo.
|
||||||
|
|
||||||
\note You can alternatively define your custom cairo FLTK window,
|
\note You can alternatively define your custom Cairo FLTK window,
|
||||||
and thus at least override the draw() method to provide custom Cairo
|
and thus at least override the draw() method to provide custom Cairo
|
||||||
support. In this case you will probably use Fl::cairo_make_current(Fl_Window*)
|
support. In this case you will probably use Fl::cairo_make_current(Fl_Window*)
|
||||||
to attach a context to your window. You should do it only when your window is
|
to attach a context to your window. You should do this only when your window is
|
||||||
the current window. \see Fl_Window::current()
|
the current window. \see Fl_Window::current()
|
||||||
*/
|
*/
|
||||||
class FL_EXPORT Fl_Cairo_Window : public Fl_Double_Window {
|
class FL_EXPORT Fl_Cairo_Window : public Fl_Double_Window {
|
||||||
|
|
||||||
@ -93,7 +95,7 @@ public:
|
|||||||
: Fl_Double_Window(X, Y, W, H, L), draw_cb_(0) {}
|
: Fl_Double_Window(X, Y, W, H, L), draw_cb_(0) {}
|
||||||
|
|
||||||
protected:
|
protected:
|
||||||
/** Overloaded to provide Cairo callback support */
|
/** Overloaded to provide Cairo callback support. */
|
||||||
void draw() FL_OVERRIDE {
|
void draw() FL_OVERRIDE {
|
||||||
Fl_Double_Window::draw();
|
Fl_Double_Window::draw();
|
||||||
if (draw_cb_) { // call the Cairo draw callback
|
if (draw_cb_) { // call the Cairo draw callback
|
||||||
|
|||||||
@ -301,8 +301,10 @@ char *Fl_String::data() {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
Return a pointer to the NUL terminated string.
|
Return a pointer to the NUL terminated string.
|
||||||
|
|
||||||
\return reference to non-mutable string
|
\return reference to non-mutable string
|
||||||
\note same as `const char *Fl_String::data() const`
|
|
||||||
|
\note same as Fl_String::data() const
|
||||||
*/
|
*/
|
||||||
const char *Fl_String::c_str() const {
|
const char *Fl_String::c_str() const {
|
||||||
return data();
|
return data();
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user