FLTK 1.4.4

Loading...
Searching...
No Matches
Fl_Cairo_Window Class Reference
Cairo Support Functions and Classes

This defines an FLTK window with Cairo support. More...

`#include <Fl_Cairo_Window.H>`

Inheritance diagram for Fl_Cairo_Window:

## Public Types
typedef void(* | cairo_draw_cb) (Fl_Cairo_Window *self, cairo_t *def)
| The Cairo draw callback prototype you need to implement.
Public Types inherited from Fl_Window
typedef struct HICON__ * | HICON

## Public Member Functions
| Fl_Cairo_Window (int W, int H, const char *L=0)
| Fl_Cairo_Window (int X, int Y, int W, int H, const char *L=0)
void | set_draw_cb (cairo_draw_cb cb)
| You must provide a draw callback that implements your Cairo rendering.
Public Member Functions inherited from Fl_Double_Window
Fl_Double_Window * | as_double_window () FL_OVERRIDE
| Return non-null if this is an Fl_Double_Window object.
| Fl_Double_Window (int W, int H, const char *l=0)
| Creates a new Fl_Double_Window widget using the given position, size, and label (title) string.
| Fl_Double_Window (int X, int Y, int W, int H, const char *l=0)
| See Fl_Double_Window::Fl_Double_Window(int w, int h, const char *label = 0).
void | flush () FL_OVERRIDE
| Forces the window to be drawn, this window is also made current and calls draw().
void | hide () FL_OVERRIDE
| Makes a widget invisible.
void | resize (int, int, int, int) FL_OVERRIDE
| Changes the size or position of the widget.
void | show () FL_OVERRIDE
| Makes a widget visible.
void | show (int a, char **b)
| Same as Fl_Window::show(int a, char **b).
| ~Fl_Double_Window ()
| The destructor also deletes all the children.
Public Member Functions inherited from Fl_Window
void | allow_expand_outside_parent ()
| Allow this subwindow to expand outside the area of its parent window.
virtual class Fl_Overlay_Window * | as_overlay_window ()
| Return non-null if this is an Fl_Overlay_Window object.
Fl_Window const * | as_window () const FL_OVERRIDE
Fl_Window * | as_window () FL_OVERRIDE
| Returns an Fl_Window pointer if this widget is an Fl_Window.
unsigned int | border () const
| Returns whether the window possesses a border.
void | border (int b)
| Sets whether or not the window manager border is around the window.
void | clear_border ()
| Fast inline function to turn the window manager border off.
void | clear_modal_states ()
| Clears the "modal" flags and converts a "modal" or "non-modal" window back into a "normal" window.
void | copy_label (const char *a)
| Sets the window titlebar label to a copy of a character string.
void | cursor (const Fl_RGB_Image *, int, int)
| Changes the cursor for this window using the provided image as cursor's shape.
void | cursor (Fl_Cursor c, Fl_Color, Fl_Color=FL_WHITE)
| For back compatibility only.
void | cursor (Fl_Cursor)
| Changes the cursor for this window.
int | decorated_h () const
| Returns the window height including any window title bar and any frame added by the window manager.
int | decorated_w () const
| Returns the window width including any frame added by the window manager.
void | default_cursor (Fl_Cursor c, Fl_Color, Fl_Color=FL_WHITE)
| For back compatibility only.
void | default_cursor (Fl_Cursor)
| Sets the default window cursor.
void | draw_backdrop ()
| Draw the background image if one is set and is aligned inside.
| Fl_Window (int w, int h, const char *title=0)
| Creates a window from the given width `w`, height `h`, and `title`.
| Fl_Window (int x, int y, int w, int h, const char *title=0)
| Creates a window from the given position (x, y), size (w, h) and title.
void | free_position ()
| Undoes the effect of a previous resize() or show() so that the next time show() is called the window manager is free to position the window.
void | fullscreen ()
| Makes the window completely fill one or more screens, without any window manager border visible.
unsigned int | fullscreen_active () const
| Returns non zero if FULLSCREEN flag is set, 0 otherwise.
void | fullscreen_off ()
| Turns off any side effects of fullscreen().
void | fullscreen_off (int X, int Y, int W, int H)
| Turns off any side effects of fullscreen() and does resize(x,y,w,h).
void | fullscreen_screens (int top, int bottom, int left, int right)
| Sets which screens should be used when this window is in fullscreen mode.
uchar | get_size_range (int *minw, int *minh, int *maxw=NULL, int *maxh=NULL, int *dw=NULL, int *dh=NULL, int *aspect=NULL)
| Gets the allowable range to which the user can resize this window.
int | handle (int) FL_OVERRIDE
| Handles the specified event.
void | hide () FL_OVERRIDE
| Removes the window from the screen.
void | hotspot (const Fl_Widget &p, int offscreen=0)
| See void Fl_Window::hotspot(int x, int y, int offscreen = 0).
void | hotspot (const Fl_Widget *, int offscreen=0)
| See void Fl_Window::hotspot(int x, int y, int offscreen = 0).
void | hotspot (int x, int y, int offscreen=0)
| Positions the window so that the mouse is pointing at the given position, or at the center of the given widget, which may be the window itself.
const void * | icon () const
| Gets the current icon window target dependent data.
void | icon (const Fl_RGB_Image *)
| Sets or resets a single window icon.
void | icon (const void *ic)
| Platform-specific method to set the window icon usable on Windows and X11 only.
void | iconize ()
| Iconifies the window.
const char * | iconlabel () const
| See void Fl_Window::iconlabel(const char*).
void | iconlabel (const char *)
| Sets the icon label.
void | icons (const Fl_RGB_Image *[], int)
| Sets the window icons.
void | icons (HICON big_icon, HICON small_icon)
| Sets the window icons using HICON handles (Windows platform only).
const char * | label () const
| See void Fl_Window::label(const char*).
void | label (const char *)
| Sets the window title bar label.
void | label (const char *label, const char *iconlabel)
| Sets the icon label.
void | make_current ()
| Sets things up so that the drawing functions in <FL/fl_draw.H> will go into this window.
void | maximize ()
| Maximizes a top-level window to its current screen.
unsigned int | maximize_active () const
| Returns whether the window is currently maximized.
unsigned int | menu_window () const
| Returns true if this window is a menu window.
unsigned int | modal () const
| Returns true if this window is modal.
unsigned int | non_modal () const
| Returns true if this window is modal or non-modal.
fl_uintptr_t | os_id ()
| Returns a platform-specific identification of a shown window, or 0 if not shown.
unsigned int | override () const
| Returns non zero if OVERRIDE flag is set, 0 otherwise.
void | resize (int X, int Y, int W, int H) FL_OVERRIDE
| Changes the size and position of the window.
int | screen_num ()
| The number of the screen containing the mapped window.
void | screen_num (int screen_num)
| Set the number of the screen where to map the window.
void | set_menu_window ()
| Marks the window as a menu window.
void | set_modal ()
| A "modal" window, when shown(), will prevent any events from being delivered to other windows in the same program, and will also remain on top of the other windows (if the X window manager supports the "transient for" property).
void | set_non_modal ()
| A "non-modal" window (terminology borrowed from Microsoft Windows) acts like a modal() one in that it remains on top, but it has no effect on event delivery.
void | set_override ()
| Activates the flags NOBORDER|OVERRIDE.
void | set_tooltip_window ()
| Marks the window as a tooltip window.
const Fl_Image * | shape ()
| Returns the image controlling the window shape or NULL.
void | shape (const Fl_Image &b)
| Set the window's shape with an Fl_Image.
void | shape (const Fl_Image *img)
| Assigns a non-rectangular shape to the window.
void | show () FL_OVERRIDE
| Puts the window on the screen.
void | show (int argc, char **argv)
| Puts the window on the screen with show() and parses command-line arguments.
int | shown ()
| Returns non-zero if show() has been called (but not hide() ).
void | size_range (int minw, int minh, int maxw=0, int maxh=0, int dw=0, int dh=0, int aspect=0)
| Sets the allowable range to which the user can resize this window.
unsigned int | tooltip_window () const
| Returns true if this window is a tooltip window.
void | un_maximize ()
| Returns a previously maximized top-level window to its previous size.
void | wait_for_expose ()
| Waits for the window to be displayed after calling show().
int | x_root () const
| Gets the x position of the window on the screen.
const char * | xclass () const
| Returns the xclass for this window, or a default.
void | xclass (const char *c)
| Sets the xclass for this window.
int | y_root () const
| Gets the y position of the window on the screen.
virtual | ~Fl_Window ()
| The destructor also deletes all the children.
Public Member Functions inherited from Fl_Group
Fl_Widget *& | _ddfdesign_kludge ()
| This is for forms compatibility only.
void | add (Fl_Widget &)
| The widget is removed from its current group (if any) and then added to the end of this group.
void | add (Fl_Widget *o)
| See void Fl_Group::add(Fl_Widget &w).
void | add_resizable (Fl_Widget &o)
| Adds a widget to the group and makes it the resizable widget.
Fl_Widget *const * | array () const
| Returns a pointer to the array of children.
Fl_Group const * | as_group () const FL_OVERRIDE
Fl_Group * | as_group () FL_OVERRIDE
| Returns an Fl_Group pointer if this widget is an Fl_Group.
void | begin ()
| Sets the current group so you can build the widget tree by just constructing the widgets.
Fl_Widget * | child (int n) const
| Returns the n'th child.
int | children () const
| Returns how many child widgets the group has.
void | clear ()
| Deletes all child widgets from memory recursively.
unsigned int | clip_children ()
| Returns the current clipping mode.
void | clip_children (int c)
| Controls whether the group widget clips the drawing of child widgets to its bounding box.
virtual int | delete_child (int n)
| Removes the widget at `index` from the group and deletes it.
void | end ()
| Exactly the same as current(this->parent()).
int | find (const Fl_Widget &o) const
| See int Fl_Group::find(const Fl_Widget *w) const.
int | find (const Fl_Widget *) const
| Searches the child array for the widget and returns the index.
| Fl_Group (int, int, int, int, const char *=0)
| Creates a new Fl_Group widget using the given position, size, and label string.
void | focus (Fl_Widget *W)
void | forms_end ()
| This is for forms compatibility only.
void | init_sizes ()
| Resets the internal array of widget sizes and positions.
void | insert (Fl_Widget &, int i)
| The widget is removed from its current group (if any) and then inserted into this group.
void | insert (Fl_Widget &o, Fl_Widget *before)
| This does insert(w, find(before)).
void | remove (Fl_Widget &)
| Removes a widget from the group but does not delete it.
void | remove (Fl_Widget *o)
| Removes the widget `o` from the group.
void | remove (int index)
| Removes the widget at `index` from the group but does not delete it.
Fl_Widget * | resizable () const
| Returns the group's resizable widget.
void | resizable (Fl_Widget &o)
| Sets the group's resizable widget.
void | resizable (Fl_Widget *o)
| The resizable widget defines both the resizing box and the resizing behavior of the group and its children.
virtual | ~Fl_Group ()
| The destructor also deletes all the children.
Public Member Functions inherited from Fl_Widget
void | _clear_fullscreen ()
void | _set_fullscreen ()
void | activate ()
| Activates the widget.
unsigned int | active () const
| Returns whether the widget is active.
int | active_r () const
| Returns whether the widget and all of its parents are active.
Fl_Align | align () const
| Gets the label alignment.
void | align (Fl_Align alignment)
| Sets the label alignment.
long | argument () const
| Gets the current user data (long) argument that is passed to the callback function.
void | argument (long v)
| Sets the current user data (long) argument that is passed to the callback function.
virtual class Fl_Gl_Window * | as_gl_window ()
| Returns an Fl_Gl_Window pointer if this widget is an Fl_Gl_Window.
virtual class Fl_Gl_Window const * | as_gl_window () const
void | bind_deimage (Fl_Image *img)
| Sets the image to use as part of the widget label when in the inactive state.
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.
void | bind_image (Fl_Image *img)
| Sets the image to use as part of the widget label when in the active state.
void | bind_image (int f)
| Bind the image to the widget, so the widget will delete the image when it is no longer needed.
Fl_Boxtype | box () const
| Gets the box type of the widget.
void | box (Fl_Boxtype new_box)
| Sets the box type for the widget.
Fl_Callback_p | callback () const
| Gets the current callback function for the widget.
void | callback (Fl_Callback *cb)
| Sets the current callback function for the widget.
void | callback (Fl_Callback *cb, Fl_Callback_User_Data *p, bool auto_free)
| Sets the current callback function and managed user data for the widget.
void | callback (Fl_Callback *cb, void *p)
| Sets the current callback function and data for the widget.
void | callback (Fl_Callback0 *cb)
| Sets the current callback function for the widget.
void | callback (Fl_Callback1 *cb, long p=0)
| Sets the current callback function for the widget.
unsigned int | changed () const
| Checks if the widget value changed since the last callback.
void | clear_active ()
| Marks the widget as inactive without sending events or changing focus.
void | clear_changed ()
| Marks the value of the widget as unchanged.
void | clear_damage (uchar c=0)
| Clears or sets the damage flags.
void | clear_output ()
| Sets a widget to accept input.
void | clear_visible ()
| Hides the widget.
void | clear_visible_focus ()
| Disables keyboard focus navigation with this widget.
Fl_Color | color () const
| Gets the background color of the widget.
void | color (Fl_Color bg)
| Sets the background color of the widget.
void | color (Fl_Color bg, Fl_Color sel)
| Sets the background and selection color of the widget.
Fl_Color | color2 () const
| For back compatibility only.
void | color2 (unsigned a)
| For back compatibility only.
int | contains (const Fl_Widget *w) const
| Checks if w is a child of this widget.
void | copy_label (const char *new_label)
| Sets the current label.
void | copy_tooltip (const char *text)
| Sets the current tooltip text.
uchar | damage () const
| Returns non-zero if draw() needs to be called.
void | damage (uchar c)
| Sets the damage bits for the widget.
void | damage (uchar c, int x, int y, int w, int h)
| Sets the damage bits for an area inside the widget.
int | damage_resize (int, int, int, int)
| Internal use only.
void | deactivate ()
| Deactivates the widget.
Fl_Image * | deimage ()
| Gets the image that is used as part of the widget label when in the inactive state.
const Fl_Image * | deimage () const
| Gets the image that is used as part of the widget label when in the inactive state.
void | deimage (Fl_Image &img)
| Sets the image to use as part of the widget label when in the inactive state.
void | deimage (Fl_Image *img)
| Sets the image to use as part of the widget label when in the inactive state.
int | deimage_bound () const
| Returns whether the inactive image is managed by the widget.
void | do_callback (Fl_Callback_Reason reason=FL_REASON_UNKNOWN)
| Calls the widget callback function with default arguments.
void | do_callback (Fl_Widget *widget, long arg, Fl_Callback_Reason reason=FL_REASON_UNKNOWN)
| Calls the widget callback function with arbitrary arguments.
void | do_callback (Fl_Widget *widget, void *arg=0, Fl_Callback_Reason reason=FL_REASON_UNKNOWN)
| Calls the widget callback function with arbitrary arguments.
void | draw_label (int, int, int, int, Fl_Align) const
| Draws the label in an arbitrary bounding box with an arbitrary alignment.
int | h () const
| Gets the widget height.
int | horizontal_label_margin ()
| Get the spacing between the label and the horizontal edge of the widget.
void | horizontal_label_margin (int px)
| Set the spacing between the label and the horizontal edge of the widget.
Fl_Image * | image ()
| Gets the image that is used as part of the widget label when in the active state.
const Fl_Image * | image () const
| Gets the image that is used as part of the widget label when in the active state.
void | image (Fl_Image &img)
| Sets the image to use as part of the widget label when in the active state.
void | image (Fl_Image *img)
| Sets the image to use as part of the widget label when in the active state.
int | image_bound () const
| Returns whether the image is managed by the widget.
int | inside (const Fl_Widget *wgt) const
| Checks if this widget is a child of `wgt`.
int | is_label_copied () const
| Returns whether the current label was assigned with copy_label().
const char * | label () const
| Gets the current label text.
void | label (const char *text)
| Sets the current label pointer.
void | label (Fl_Labeltype a, const char *b)
| Shortcut to set the label text and type in one call.
int | label_image_spacing ()
| Return the gap size between the label and the image.
void | label_image_spacing (int gap)
| Set the gap between the label and the image in pixels.
Fl_Color | labelcolor () const
| Gets the label color.
void | labelcolor (Fl_Color c)
| Sets the label color.
Fl_Font | labelfont () const
| Gets the font to use.
void | labelfont (Fl_Font f)
| Sets the font to use.
Fl_Fontsize | labelsize () const
| Gets the font size in pixels.
void | labelsize (Fl_Fontsize pix)
| Sets the font size in pixels.
Fl_Labeltype | labeltype () const
| Gets the label type.
void | labeltype (Fl_Labeltype a)
| Sets the label type.
void | measure_label (int &ww, int &hh) const
| Sets width ww and height hh accordingly with the label size.
bool | needs_keyboard () const
| Returns whether this widget needs a keyboard.
void | needs_keyboard (bool needs)
| Sets whether this widget needs a keyboard.
unsigned int | output () const
| Returns if a widget is used for output only.
Fl_Group * | parent () const
| Returns a pointer to the parent widget.
void | parent (Fl_Group *p)
| Internal use only - "for hacks only".
void | position (int X, int Y)
| Repositions the window or widget.
void | redraw ()
| Schedules the drawing of the widget.
void | redraw_label ()
| Schedules the drawing of the label.
Fl_Color | selection_color () const
| Gets the selection color.
void | selection_color (Fl_Color a)
| Sets the selection color.
void | set_active ()
| Marks the widget as active without sending events or changing focus.
void | set_changed ()
| Marks the value of the widget as changed.
void | set_output ()
| Sets a widget to output only.
void | set_visible ()
| Makes the widget visible.
void | set_visible_focus ()
| Enables keyboard focus navigation with this widget.
int | shortcut_label () const
| Returns whether the widget's label uses '&' to indicate shortcuts.
void | shortcut_label (int value)
| Sets whether the widget's label uses '&' to indicate shortcuts.
void | size (int W, int H)
| Changes the size of the widget.
int | take_focus ()
| Gives the widget the keyboard focus.
unsigned int | takesevents () const
| Returns if the widget is able to take events.
int | test_shortcut ()
| Returns true if the widget's label contains the entered '&x' shortcut.
const char * | tooltip () const
| Gets the current tooltip text.
void | tooltip (const char *text)
| Sets the current tooltip text.
Fl_Window * | top_window () const
| Returns a pointer to the top-level window for the widget.
Fl_Window * | top_window_offset (int &xoff, int &yoff) const
| Finds the x/y offset of the current widget relative to the top-level window.
uchar | type () const
| Gets the widget type.
void | type (uchar t)
| Sets the widget type.
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.
void | user_data (Fl_Callback_User_Data *v, bool auto_free)
| Sets the user data for this widget.
void | user_data (void *v)
| Sets the user data for this widget.
int | vertical_label_margin ()
| Get the spacing between the label and the vertical edge of the widget.
void | vertical_label_margin (int px)
| Set the spacing between the label and the vertical edge of the widget.
unsigned int | visible () const
| Returns whether a widget is visible.
unsigned int | visible_focus () const
| Checks whether this widget has a visible focus.
void | visible_focus (int v)
| Modifies keyboard focus navigation.
int | visible_r () const
| Returns whether a widget and all its parents are visible.
int | w () const
| Gets the widget width.
Fl_When | when () const
| Returns the conditions under which the callback is called.
void | when (uchar i)
| Sets the flags used to decide when a callback is called.
Fl_Window * | window () const
| Returns a pointer to the nearest parent window up the widget hierarchy.
int | x () const
| Gets the widget position in its window.
int | y () const
| Gets the widget position in its window.
virtual | ~Fl_Widget ()
| Destroys the widget.

## Protected Member Functions
void | draw () FL_OVERRIDE
| Overloaded to provide Cairo callback support.
Protected Member Functions inherited from Fl_Window
void | default_size_range ()
| Protected method to calculate the default size range of a window.
void | draw () FL_OVERRIDE
| Draws the widget.
int | force_position () const
| Returns the internal state of the window's `FORCE_POSITION` flag.
void | force_position (int force)
| Sets an internal flag that tells FLTK and the window manager to honor position requests.
void | free_icons ()
| Deletes all icons previously attached to the window.
int | is_resizable ()
| Protected method to determine whether a window is resizable.
Protected Member Functions inherited from Fl_Group
Fl_Rect * | bounds ()
| Returns the internal array of widget sizes and positions.
void | draw_child (Fl_Widget &widget) const
| Forces a child to redraw.
void | draw_children ()
| Draws all children of the group.
void | draw_outside_label (const Fl_Widget &widget) const
| Parents normally call this to draw outside labels of child widgets.
virtual int | on_insert (Fl_Widget *, int)
| Allow derived groups to act when a widget is added as a child.
virtual int | on_move (int, int)
| Allow derived groups to act when a widget is moved within the group.
virtual void | on_remove (int)
| Allow derived groups to act when a child widget is removed from the group.
int * | sizes ()
| Returns the internal array of widget sizes and positions.
void | update_child (Fl_Widget &widget) const
| Draws a child only if it needs it.
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.
void | draw_focus (Fl_Boxtype t, int X, int Y, int W, int H) const
| Draws a focus rectangle around the widget.
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.
void | draw_label () const
| Draws the widget's label at the defined label position.
void | draw_label (int, int, int, int) const
| Draws the label in an arbitrary bounding box.
| Fl_Widget (int x, int y, int w, int h, const char *label=0L)
| Creates a widget at the given position and size.
unsigned int | flags () const
| Gets the widget flags mask.
void | h (int v)
| Internal use only.
void | set_flag (unsigned int c)
| Sets a flag in the flags mask.
void | w (int v)
| Internal use only.
void | x (int v)
| Internal use only.
void | y (int v)
| Internal use only.

## Additional Inherited Members
Static Public Member Functions inherited from Fl_Window
static Fl_Window * | current ()
| Returns the last window that was made current.
static void | default_callback (Fl_Window *, void *v)
| Back compatibility: Sets the default callback v for win to call on close event.
static void | default_icon (const Fl_RGB_Image *)
| Sets a single default window icon.
static void | default_icons (const Fl_RGB_Image *[], int)
| Sets the default window icons.
static void | default_icons (HICON big_icon, HICON small_icon)
| Sets the default window icons (Windows platform only).
static const char * | default_xclass ()
| Returns the default xclass.
static void | default_xclass (const char *)
| Sets the default window xclass.
static bool | is_a_rescale ()
| Returns true when a window is being rescaled.
static char | show_next_window_iconic ()
| Returns the static flag whether the next window should be opened iconified.
static void | show_next_window_iconic (char stat)
| Sets a static flag whether the next window should be opened iconified.
Static Public Member Functions inherited from Fl_Group
static Fl_Group * | current ()
| Returns the currently active group.
static void | current (Fl_Group *g)
| Sets the current group.
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.
static unsigned int | label_shortcut (const char *t)
| Returns the Unicode value of the '&x' shortcut in a given text.
static int | test_shortcut (const char *, const bool require_alt=false)
| Returns true if the given text `t` contains the entered '&x' shortcut.
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 , AUTO_DELETE_USER_DATA = 1<<23 , MAXIMIZED = 1<<24 , POPUP = 1<<25 , USERFLAG3 = 1<<29 , USERFLAG2 = 1<<30 , USERFLAG1 = 1<<31 }
| flags possible values enumeration. More...
Static Protected Attributes inherited from Fl_Window
static Fl_Window * | current_
| Stores the last window that was made current.

## Detailed Description

This defines an FLTK window with Cairo support.

This class overloads the virtual draw() method for you, so that the only thing you have to do is to provide your Cairo code. All Cairo context handling is achieved transparently.

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 relative to the 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). Example:

static void my_cairo_draw_cb(Fl_Cairo_Window *window, cairo_t *cr) {
// Draw an "X"
const double xmax = (window->w() - 1);
const double ymax = (window->h() - 1);
cairo_set_line_width(cr, 1.00); // line width for drawing
cairo_set_source_rgb(cr, 1.0, 0.5, 0.0); // orange
cairo_move_to(cr, 0.0, 0.0); cairo_line_to(cr, xmax, ymax); // draw diagonal "\"
cairo_move_to(cr, 0.0, ymax); cairo_line_to(cr, xmax, 0.0); // draw diagonal "/"
cairo_stroke(cr); // stroke the lines
}

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). 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() with the widget's w() and h() values. Example:

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
[..use 0.0 to 1.0 values from here on..]
}

See also
  examples/cairo-draw-x.cxx
  test/cairo_test.cxx

Note
  Class Fl_Cairo_Window requires the FLTK library to have been built with CMake option FLTK_OPTION_CAIRO_WINDOW or configure –enable-cairo.
  You can alternatively define your custom Cairo FLTK window, 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*) to attach a context to your window. You should do this only when your window is the current window.

See also
  Fl_Window::current()

## Member Function Documentation

## ◆ draw()

void Fl_Cairo_Window::draw | ( | void |  | ) |
| inline protected virtual

Overloaded to provide Cairo callback support.

Implements Fl_Widget.

## ◆ set_draw_cb()

void Fl_Cairo_Window::set_draw_cb | ( | cairo_draw_cb | cb | ) |
| inline

You must provide a draw callback that implements your Cairo rendering.

This method permits you to set your Cairo callback to `cb`.

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

- Fl_Cairo_Window.H