Fl_Window.H

Go to the documentation of this file.

//
// Window header file for the Fast Light Tool Kit (FLTK).
//
// Copyright 1998-2023 by Bill Spitzak and others.
//
// This library is free software. Distribution and use rights are outlined in
// the file "COPYING" which should have been included with this file.  If this
// file is missing or damaged, see the license at:
//
//     https://www.fltk.org/COPYING.php
//
// Please see the following page on how to report bugs and issues:
//
//     https://www.fltk.org/bugs.php
//
 
#ifndef Fl_Window_H
#define Fl_Window_H
 
#include <FL/Fl.H>
#include <FL/Fl_Group.H>
#include <FL/Fl_Bitmap.H>
 
#define FL_WINDOW 0xF0          
#define FL_DOUBLE_WINDOW 0xF1   
 
class Fl_X;
class Fl_Window_Driver;
class Fl_RGB_Image;
class Fl_Double_Window;
 
class FL_EXPORT Fl_Window : public Fl_Group {
  friend class Fl_X;
  friend class Fl_Window_Driver;
private:
  static char *default_xclass_;
  static char show_next_window_iconic_; // 1 means create next window in iconic form
 
  int no_fullscreen_x;
  int no_fullscreen_y;
  int no_fullscreen_w;
  int no_fullscreen_h;
  int fullscreen_screen_top;
  int fullscreen_screen_bottom;
  int fullscreen_screen_left;
  int fullscreen_screen_right;
 
  // TODO: it would make sense to merge the use of Fl_X and Fl_Window_Driver, maybe simply by
  // TODO: deriving Fl_Window_Driver from Fl_X. However, there are a lot of historic kludges
  // TODO: for some platforms around Fl_X.
  Fl_X *flx_; // points at the system-specific stuff, but exists only after the window is mapped
  Fl_Window_Driver *pWindowDriver; // points at the system-specific stuff at window creation time
 
  const char* iconlabel_;
  char* xclass_;
 
  // private size_range stuff:
  int minw_, minh_, maxw_, maxh_;
  int dw_, dh_, aspect_;
  uchar size_range_set_;        // true (1) if size_range() has been set or calculated
 
  // cursor stuff
  Fl_Cursor cursor_default;
 
  void _Fl_Window(); // constructor innards
 
  // unimplemented copy ctor and assignment operator
  Fl_Window(const Fl_Window&);
  Fl_Window& operator=(const Fl_Window&);
 
  void is_maximized_(bool b);
 
protected:
 
  static Fl_Window *current_;
  void draw() FL_OVERRIDE;
  virtual void flush();
 
  void force_position(int force) {
    if (force) set_flag(FORCE_POSITION);
    else clear_flag(FORCE_POSITION);
  }
  int force_position() const { return ((flags() & FORCE_POSITION)?1:0); }
 
  void free_icons();
 
  void default_size_range();  // calculate size_range() if not set explicitly
  int is_resizable();         // calculate size_range() and return whether this is resizable
 
public:
 
    Fl_Window(int w, int h, const char *title = 0);
    Fl_Window(int x, int y, int w, int h, const char *title = 0);
    virtual ~Fl_Window();
 
  int handle(int) FL_OVERRIDE;
 
  void resize(int X,int Y,int W,int H) FL_OVERRIDE;
  void border(int b);
  void clear_border()   {set_flag(NOBORDER);}
  unsigned int border() const   {return !(flags() & NOBORDER);}
  void set_override()   {set_flag(NOBORDER|OVERRIDE);}
  unsigned int override() const  { return flags()&OVERRIDE; }
  void set_modal()      {set_flag(MODAL);}
  unsigned int modal() const    {return flags() & MODAL;}
  void set_non_modal()  {set_flag(NON_MODAL);}
  unsigned int non_modal() const {return flags() & (NON_MODAL|MODAL);}
 
  void clear_modal_states() {clear_flag(NON_MODAL | MODAL);}
 
  void set_menu_window()        {set_flag(MENU_WINDOW);}
 
  unsigned int menu_window() const {return flags() & MENU_WINDOW;}
 
  void set_tooltip_window()     { set_flag(TOOLTIP_WINDOW);
                                  clear_flag(MENU_WINDOW); }
  unsigned int tooltip_window() const {return flags() & TOOLTIP_WINDOW;}
 
  void hotspot(int x, int y, int offscreen = 0);
  void hotspot(const Fl_Widget*, int offscreen = 0);
  void hotspot(const Fl_Widget& p, int offscreen = 0) {hotspot(&p,offscreen);}
 
  void free_position()  {clear_flag(FORCE_POSITION);}
 
  void size_range(int minw, int minh, int maxw=0, int maxh=0, int dw=0, int dh=0, int aspect=0);
 
  uchar get_size_range(int *minw, int *minh, int *maxw=NULL, int *maxh=NULL, int *dw=NULL, int *dh=NULL, int *aspect=NULL);
 
  const char* label() const     {return Fl_Widget::label();}
  const char* iconlabel() const {return iconlabel_;}
  void label(const char*);
  void iconlabel(const char*);
  void label(const char* label, const char* iconlabel); // platform dependent
  void copy_label(const char* a);
 
  static void default_xclass(const char*);
  static const char *default_xclass();
  const char* xclass() const;
  void xclass(const char* c);
 
  static void default_icon(const Fl_RGB_Image*);
  static void default_icons(const Fl_RGB_Image*[], int);
  void icon(const Fl_RGB_Image*);
  void icons(const Fl_RGB_Image*[], int);
 
#if defined(_WIN32) || defined(FL_DOXYGEN)
  typedef struct HICON__* HICON;
  // These 2 member functions break the driver model but are kept for back compatibility.
  // They are implemented in Fl_win32.cxx
 
  static void default_icons(HICON big_icon, HICON small_icon);
 
  void icons(HICON big_icon, HICON small_icon);
#endif // defined(_WIN32) || defined(FL_DOXYGEN)
 
  /* for legacy compatibility */
  const void* icon() const;
  void icon(const void * ic);
 
  int shown() {return flx_ != 0;}
  void show() FL_OVERRIDE;
  void hide() FL_OVERRIDE;
  void show(int argc, char **argv);
 
  // Enables synchronous show(), docs in Fl_Window.cxx
  void wait_for_expose();
 
  void fullscreen();
  void fullscreen_off();
  void fullscreen_off(int X,int Y,int W,int H);
  unsigned int fullscreen_active() const { return flags() & FULLSCREEN; }
  void fullscreen_screens(int top, int bottom, int left, int right);
 
  void maximize();
  void un_maximize();
  unsigned int maximize_active() const { return flags() & MAXIMIZED; }
public:
  void iconize();
 
  int x_root() const ;
  int y_root() const ;
 
 static Fl_Window *current();
  void make_current();
 
  void cursor(Fl_Cursor);
  void cursor(const Fl_RGB_Image*, int, int);
  void default_cursor(Fl_Cursor);
 
  /* for legacy compatibility */
  void cursor(Fl_Cursor c, Fl_Color, Fl_Color=FL_WHITE);
  void default_cursor(Fl_Cursor c, Fl_Color, Fl_Color=FL_WHITE);
 
  static void default_callback(Fl_Window*, void* v);
 
  int decorated_w() const;
 
  int decorated_h() const;
 
  // Note: Doxygen docs in Fl_Widget.H to avoid redundancy.
  Fl_Window* as_window() FL_OVERRIDE { return this; }
  Fl_Window const* as_window() const FL_OVERRIDE { return this; }
 
  virtual class Fl_Overlay_Window *as_overlay_window() {return 0L; }
 
  virtual class Fl_Double_Window *as_double_window() {return 0L;}
 
  void shape(const Fl_Image* img);
  void shape(const Fl_Image& b);
  const Fl_Image *shape();
  void draw_backdrop();
  int screen_num();
  void screen_num(int screen_num);
  static bool is_a_rescale();
  fl_uintptr_t os_id();
 
  static void show_next_window_iconic(char stat) {
    show_next_window_iconic_ = stat ? 1 : 0;
  }
 
  static char show_next_window_iconic() {
    return show_next_window_iconic_;
  }
 
  void allow_expand_outside_parent();
 
};
 
#endif