ytkmm/ytkmm/gtkmm/window.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_WINDOW_H
#define _GTKMM_WINDOW_H
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* $Id: window.hg,v 1.20 2006/05/10 20:59:28 murrayc Exp $ */
 
/* window.h
 *
 * Copyright (C) 1998-2002 The gtkmm Development Team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
#include <glibmm/object.h>
#include <glibmm/listhandle.h>
#include <gtkmm/bin.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkWindowGroup GtkWindowGroup;
typedef struct _GtkWindowGroupClass GtkWindowGroupClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{ class WindowGroup_Class; } // namespace Gtk
#endif //DOXYGEN_SHOULD_SKIP_THIS
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkWindow GtkWindow;
typedef struct _GtkWindowClass GtkWindowClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{ class Window_Class; } // namespace Gtk
namespace Gtk
{
 
class AccelGroup;
class WindowGroup;
 
class WindowGroup : public Glib::Object
{
  
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
public:
  typedef WindowGroup CppObjectType;
  typedef WindowGroup_Class CppClassType;
  typedef GtkWindowGroup BaseObjectType;
  typedef GtkWindowGroupClass BaseClassType;
 
private:  friend class WindowGroup_Class;
  static CppClassType windowgroup_class_;
 
private:
  // noncopyable
  WindowGroup(const WindowGroup&);
  WindowGroup& operator=(const WindowGroup&);
 
protected:
  explicit WindowGroup(const Glib::ConstructParams& construct_params);
  explicit WindowGroup(GtkWindowGroup* castitem);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
public:
  virtual ~WindowGroup();
 
  static GType get_type()      G_GNUC_CONST;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
 
  static GType get_base_type() G_GNUC_CONST;
#endif
 
  GtkWindowGroup*       gobj()       { return reinterpret_cast<GtkWindowGroup*>(gobject_); }
 
  const GtkWindowGroup* gobj() const { return reinterpret_cast<GtkWindowGroup*>(gobject_); }
 
  GtkWindowGroup* gobj_copy();
 
private:
 
 
protected:
  WindowGroup();
 
public:
  
  static Glib::RefPtr<WindowGroup> create();
 
 
  void add_window(Window& window);
  
  void remove_window(Window& window);
 
 
public:
 
public:
  //C++ methods used to invoke GTK+ virtual functions:
 
protected:
  //GTK+ Virtual Functions (override these to change behaviour):
 
  //Default Signal Handlers::
 
 
};
 
class Window : public Bin
{
  public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef Window CppObjectType;
  typedef Window_Class CppClassType;
  typedef GtkWindow BaseObjectType;
  typedef GtkWindowClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
  virtual ~Window();
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
private:
  friend class Window_Class;
  static CppClassType window_class_;
 
  // noncopyable
  Window(const Window&);
  Window& operator=(const Window&);
 
protected:
  explicit Window(const Glib::ConstructParams& construct_params);
  explicit Window(GtkWindow* castitem);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  static GType get_type()      G_GNUC_CONST;
 
 
  static GType get_base_type() G_GNUC_CONST;
#endif
 
  GtkWindow*       gobj()       { return reinterpret_cast<GtkWindow*>(gobject_); }
 
  const GtkWindow* gobj() const { return reinterpret_cast<GtkWindow*>(gobject_); }
 
 
public:
  //C++ methods used to invoke GTK+ virtual functions:
 
protected:
  //GTK+ Virtual Functions (override these to change behaviour):
 
  //Default Signal Handlers::
  virtual void on_set_focus(Widget* focus);
  virtual bool on_frame_event(GdkEvent* event);
 
 
private:
 
  
  //gtkmmproc error: _gtk_window_internal_set_focus : ignored method defs lookup failed//gtkmmproc error: _gtk_window_reposition : ignored method defs lookup failed//gtkmmproc error: _gtk_window_constrain_size : ignored method defs lookup failed//gtkmmproc error: _gtk_window_get_group : ignored method defs lookup failed//gtkmmproc error: _gtk_window_activate_key : ignored method defs lookup failed//gtkmmproc error: _gtk_window_keys_foreach : ignored method defs lookup failed
public:
    explicit Window(WindowType type =  WINDOW_TOPLEVEL);
 
 
  Glib::PropertyProxy_ReadOnly< WindowType > property_type() const;
 
 
  Glib::PropertyProxy< Glib::ustring > property_title() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_title() const;
 
  Glib::PropertyProxy_WriteOnly< Glib::ustring > property_startup_id() ;
 
 
  Glib::PropertyProxy< bool > property_allow_shrink() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_allow_shrink() const;
 
  Glib::PropertyProxy< bool > property_allow_grow() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_allow_grow() const;
 
  Glib::PropertyProxy< bool > property_resizable() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_resizable() const;
 
  Glib::PropertyProxy< bool > property_modal() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_modal() const;
 
  Glib::PropertyProxy< WindowPosition > property_window_position() ;
 
  Glib::PropertyProxy_ReadOnly< WindowPosition > property_window_position() const;
 
  Glib::PropertyProxy< int > property_default_width() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_default_width() const;
 
  Glib::PropertyProxy< int > property_default_height() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_default_height() const;
 
  Glib::PropertyProxy< bool > property_destroy_with_parent() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_destroy_with_parent() const;
 
  Glib::PropertyProxy< Glib::RefPtr<Gdk::Pixbuf> > property_icon() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::Pixbuf> > property_icon() const;
 
  Glib::PropertyProxy< bool > property_mnemonics_visible() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_mnemonics_visible() const;
 
  Glib::PropertyProxy< Glib::ustring > property_icon_name() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_icon_name() const;
 
  Glib::PropertyProxy< Glib::RefPtr<Gdk::Screen> > property_screen() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::Screen> > property_screen() const;
 
  Glib::PropertyProxy_ReadOnly< bool > property_is_active() const;
 
 
  Glib::PropertyProxy_ReadOnly< bool > property_has_toplevel_focus() const;
 
 
  Glib::PropertyProxy< GdkWindowTypeHint > property_type_hint() ;
 
  Glib::PropertyProxy_ReadOnly< GdkWindowTypeHint > property_type_hint() const;
 
  Glib::PropertyProxy< bool > property_skip_taskbar_hint() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_skip_taskbar_hint() const;
 
  Glib::PropertyProxy< bool > property_skip_pager_hint() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_skip_pager_hint() const;
 
  Glib::PropertyProxy< Glib::ustring > property_role() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_role() const;
 
  Glib::PropertyProxy< bool > property_decorated() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_decorated() const;
 
  Glib::PropertyProxy< Gdk::Gravity > property_gravity() ;
 
  Glib::PropertyProxy_ReadOnly< Gdk::Gravity > property_gravity() const;
 
  Glib::PropertyProxy< Window* > property_transient_for() ;
 
  Glib::PropertyProxy_ReadOnly< Window* > property_transient_for() const;
 
  Glib::PropertyProxy< double > property_opacity() ;
 
  Glib::PropertyProxy_ReadOnly< double > property_opacity() const;
 
  Glib::PropertyProxy< bool > property_urgency_hint() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_urgency_hint() const;
 
  Glib::PropertyProxy< bool > property_accept_focus() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_accept_focus() const;
 
  Glib::PropertyProxy< bool > property_focus_on_map() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_focus_on_map() const;
 
  Glib::PropertyProxy< bool > property_deletable() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_deletable() const;
 
 
#ifndef GTKMM_DISABLE_DEPRECATED
 
 
  bool is_toplevel() const;
 
  bool is_popup() const;
 
  // This is special to the GTK+ linux-fb port.
   Glib::RefPtr<Gdk::Window> get_frame();
  Glib::RefPtr<const Gdk::Window> get_frame() const;
 
#endif // GTKMM_DISABLE_DEPRECATED
 
 
  Glib::SignalProxy1< void,Widget* > signal_set_focus();
 
  
  Glib::SignalProxy1< bool,GdkEvent* > signal_frame_event();
 
 
  //Keybinding signals:
  
  
  //gtkmmproc error: move_focus : ignored signal defs lookup failed
 
 
  void set_title(const Glib::ustring& title);
 
  
  Glib::ustring get_title() const;
 
  
  void set_wmclass(const Glib::ustring& wmclass_name, const Glib::ustring& wmclass_class);
 
  
  void set_role(const Glib::ustring& role);
 
  
  Glib::ustring get_role() const;
 
 
  void add_accel_group(const Glib::RefPtr<AccelGroup>& accel_group);
 
  
  void remove_accel_group(const Glib::RefPtr<AccelGroup>& accel_group);
 
  
  void set_position(WindowPosition position);
 
  
  bool activate_focus();
 
  
  void set_focus(Gtk::Widget& focus);
  void unset_focus();
 
  
  Widget* get_focus();
  
  const Widget* get_focus() const;
  
  void set_default(Gtk::Widget& default_widget);
  void unset_default();
 
  
  bool activate_default();
 
  
  void set_transient_for(Window& parent);
 
  void unset_transient_for();
 
  
  Window* get_transient_for();
  
  const Window* get_transient_for() const;
 
  
  void set_opacity(double opacity);
  
  double get_opacity() const;
 
  
  void set_type_hint(Gdk::WindowTypeHint hint);
  
  Gdk::WindowTypeHint get_type_hint() const;
 
  
  void set_skip_taskbar_hint(bool setting =  true);
  
  bool get_skip_taskbar_hint() const;
 
  
  void set_skip_pager_hint(bool setting =  true);
  
  bool get_skip_pager_hint() const;
 
  
  void set_urgency_hint(bool setting =  true);
  
  bool get_urgency_hint() const;
 
  
  void set_accept_focus(bool setting =  true);
  
  bool get_accept_focus() const;
  
  void set_focus_on_map(bool setting =  true);
  
  bool get_focus_on_map() const;
 
  //_WRAP_METHOD(void set_destroy_with_parent(bool setting = true), gtk_window_set_destroy_with_parent)
  // I don't that that this is ever a good thing for C++.murrayc.
 
  //TODO: Remove?
  
  bool get_destroy_with_parent() const;
  // I don't that that this is ever a good thing for C++.murrayc.
 
  
  void set_mnemonics_visible(bool setting =  true);
  
  bool get_mnemonics_visible() const;
 
  
  void set_resizable(bool resizable =  true);
 
  
  bool get_resizable() const;
 
  
  void set_gravity(Gdk::Gravity gravity);
 
  
  Gdk::Gravity get_gravity() const;
 
  
  void set_geometry_hints(Widget& geometry_widget, const Gdk::Geometry& geometry, Gdk::WindowHints geom_mask);
 
  
  void set_screen(const Glib::RefPtr<Gdk::Screen>& screen);
 
  
  Glib::RefPtr<Gdk::Screen> get_screen();
  
  Glib::RefPtr<const Gdk::Screen> get_screen() const;
 
 
#ifndef GTKMM_DISABLE_DEPRECATED
 
  void set_has_frame(bool setting =  true);
#endif // GTKMM_DISABLE_DEPRECATED
 
 
#ifndef GTKMM_DISABLE_DEPRECATED
 
  bool get_has_frame() const;
#endif // GTKMM_DISABLE_DEPRECATED
 
 
#ifndef GTKMM_DISABLE_DEPRECATED
 
  void set_frame_dimensions(int left, int top, int right, int bottom);
#endif // GTKMM_DISABLE_DEPRECATED
 
 
#ifndef GTKMM_DISABLE_DEPRECATED
 
  void get_frame_dimensions(int& left, int& top, int& right, int& bottom) const;
#endif // GTKMM_DISABLE_DEPRECATED
 
 
  void set_decorated(bool setting =  true);
  
  bool get_decorated() const;
 
  
  void set_deletable(bool setting =  true);
  
  bool get_deletable() const;
 
  
  Glib::ListHandle< Glib::RefPtr<Gdk::Pixbuf> > get_icon_list();
  
  Glib::ListHandle< Glib::RefPtr<const Gdk::Pixbuf> > get_icon_list() const;
 
  
  void set_icon_list(const Glib::ListHandle< Glib::RefPtr<Gdk::Pixbuf> >& list);
 
  
  void set_icon(const Glib::RefPtr<Gdk::Pixbuf>& icon);
 
  //TODO: Correct the since tag.
  
  void set_icon_name(const Glib::ustring& name);
  
  bool set_icon_from_file(const std::string& filename);
 
  
  Glib::RefPtr<Gdk::Pixbuf> get_icon();
  
  Glib::RefPtr<const Gdk::Pixbuf> get_icon() const;
 
  
  Glib::ustring get_icon_name() const;
 
  
  static void set_default_icon_list(const Glib::ListHandle< Glib::RefPtr<Gdk::Pixbuf> >& list);
 
  
  static Glib::ListHandle< Glib::RefPtr<Gdk::Pixbuf> > get_default_icon_list();
 
  
  static void set_default_icon(const Glib::RefPtr<Gdk::Pixbuf>& icon);
  
  static void set_default_icon_name(const Glib::ustring& name);
  
  static bool set_default_icon_from_file(const std::string& filename);
  
  static void set_auto_startup_notification(bool setting =  true);
 
  
  void set_modal(bool modal =  true);
 
  
  bool get_modal() const;
 
 
  static Glib::ListHandle<Window*> list_toplevels();
 
 
  void add_mnemonic(guint keyval, Widget& target);
 
  
  void remove_mnemonic(guint keyval, Widget& target);
 
  
  bool mnemonic_activate(guint keyval, Gdk::ModifierType modifier);
 
  
  void set_mnemonic_modifier(Gdk::ModifierType modifier);
 
  
  Gdk::ModifierType get_mnemonic_modifier();
 
 
  void present();
  
  void present(guint32 timestamp);
 
  
  void iconify();
  
  void deiconify();
 
  
  void stick();
  
  void unstick();
 
  
  void maximize();
  
  void unmaximize();
 
  
  void fullscreen();
  
  void unfullscreen();
 
  
  void begin_resize_drag(Gdk::WindowEdge edge, int button, int root_x, int root_y, guint32 timestamp);
 
  
  void begin_move_drag(int button, int root_x, int root_y, guint32 timestamp);
 
  
  void set_default_size(int width, int height);
 
  
  void get_default_size(int& width, int& height) const;
 
  
  void resize(int width, int height);
 
  
  void get_size(int& width, int& height) const;
 
 
  void move(int x, int y);
 
  
  void get_position(int& root_x, int& root_y) const;
 
  
  bool parse_geometry(const Glib::ustring& geometry);
 
  
  Glib::RefPtr<WindowGroup> get_group();
  
  Glib::RefPtr<const WindowGroup> get_group() const;
 
  
  WindowType get_window_type() const;
 
  
  void reshow_with_initial_size();
 
 
  void set_keep_above(bool setting =  true);
  
  void set_keep_below(bool setting =  true);
 
 
  Glib::RefPtr<AccelGroup> get_accel_group();
 
  virtual void raise();
 
  virtual void set_manage();
 
protected:
 
  //See comments in the implementations:
  void destroy_();
  void _destroy_c_instance();
 
private:
 
  //We'll create an accel_group if it's requested, and remember it.
  //Otherwise, you'd have to create it, add it to the window, then remember it somewhere else while you add it to other widgets.
  Glib::RefPtr<AccelGroup> accel_group_;
 
 
};
 
 
} // namespace Gtk
 
 
namespace Glib
{
  Glib::RefPtr<Gtk::WindowGroup> wrap(GtkWindowGroup* object, bool take_copy = false);
}
 
 
namespace Glib
{
  Gtk::Window* wrap(GtkWindow* object, bool take_copy = false);
} //namespace Glib
 
 
#endif /* _GTKMM_WINDOW_H */