core/vgui/impl/gtk2/vgui_gtk2_adaptor.h

Go to the documentation of this file.

// This is core/vgui/impl/gtk2/vgui_gtk2_adaptor.h
#ifndef vgui_gtk2_adaptor_h_
#define vgui_gtk2_adaptor_h_
#ifdef VCL_NEEDS_PRAGMA_INTERFACE
#pragma interface
#endif
//:
// \file
// \author Philip C. Pritchett, Robotics Research Group, University of Oxford
// \date   19 Dec 99
// \brief  The GTK implementation of vgui_adaptor.
//
// \verbatim
//  Modifications
//   07-JAN-2011 Lianqing Yu 
//   Change the way of connecting GDK events to the callback functions.
//   In original code, all GDK events are connected to a single callback 
//   function. This results in the unavailability of GL context after
//   adaptor initialization, and thus failure of OpenGL function calls.
//   The new method fixes this bug.
//   Run the vgui example example_gllist_tableau.cxx to see the result of
//   generating OpenGL display list during initialization of tableau tree.
// \endverbatim

#include <vgui/vgui_adaptor.h>
#include <vgui/internals/vgui_adaptor_mixin.h>
#include <vcl_map.h>

#include <gtk/gtk.h>

struct vgui_overlay_helper;
class vgui_gtk2_window;

//: The GTK implementation of vgui_adaptor.
class vgui_gtk2_adaptor : public vgui_adaptor, public vgui_adaptor_mixin
{
 public:
  typedef vgui_adaptor_mixin mixin;

  vgui_gtk2_adaptor(vgui_gtk2_window* win = 0);
  ~vgui_gtk2_adaptor();

  // vgui_adaptor methods
  void swap_buffers();
  void make_current();
  void post_redraw();
  void post_overlay_redraw();
  void post_timer(float,int);
  void post_destroy();  // schedules destruction of parent vgui_window

  void kill_timer(int);

  unsigned get_width() const {return mixin::width;}
  unsigned get_height() const {return mixin::height;}
  void bind_popups(vgui_modifier m, vgui_button b)
  { mixin::popup_modifier = m; mixin::popup_button = b; }
  void get_popup_bindings(vgui_modifier &m, vgui_button &b) const
  { m = mixin::popup_modifier; b = mixin::popup_button; }

  void set_default_popup(vgui_menu);
  vgui_menu get_popup();

  void draw();
  void reshape();

  // Do any idle processing that needs to be done.
  // Return true if idle processing is not complete
  bool do_idle();

  //: Flags than a child requests idle processing
  void post_idle_request();

  // Returns NULL if the empty constructor was used
  vgui_window* get_window() const;

  // gtk stuff
  GtkWidget *get_glarea_widget() { return widget; }

 private:
  // main GDK-to-vgui event dispatcher
  static gint handle(const vgui_event&, GtkWidget*, GdkEvent*, gpointer);
  static gint handle_configure(GtkWidget*, GdkEvent*, gpointer);
  static gint handle_draw(GtkWidget*, GdkEvent*, gpointer);
  static gint handle_motion_notify(GtkWidget*, GdkEvent*, gpointer);
  static gint handle_button(GtkWidget*, GdkEvent*, gpointer);
  static gint handle_key(GtkWidget*, GdkEvent*, gpointer);
  static gint handle_enter_leave(GtkWidget*, GdkEvent*, gpointer);

  // idle callbacks which service pending redraw/destroy posts
  static gint idle_callback_for_redraw(gpointer data);
  static gint idle_callback_for_tableaux(gpointer data);
  static gint idle_callback_for_destroy(gpointer data);

  // Flags to prevent queuing of multiple redraw/destroy callbacks
  bool redraw_requested;
  bool destroy_requested;

  //: True while an idle time has been requested but not implemented.
  bool idle_request_posted_;

  // pointer to the gtkglarea widget
  GtkWidget *widget;

  // pointer to the window which contains this adaptor
  vgui_gtk2_window* win_;

  // pointer to overlay emulation data
  vgui_overlay_helper *ovl_helper;

  //: internal struct for timer
  struct internal_timer{
    gint real_id_;
    void* callback_ptr_;
    
    internal_timer() : real_id_(0), callback_ptr_(0) { }
    internal_timer(gint id, void* p) 
    : real_id_(id), callback_ptr_(p) { }
  };
    
  // map of timers currently in use
  vcl_map<int, internal_timer>  timers_;
  
  // This is a place to store any menu passed in,
  // so that it doesn't go out of scope while the popup is on screen.
  static vgui_menu last_popup;

  // last position where mouse was seen.
  int last_mouse_x, last_mouse_y;
};

#endif // vgui_gtk2_adaptor_h_