tk/ytkmm/ytkmm/gtkmm/button.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_BUTTON_H
#define _GTKMM_BUTTON_H
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* $Id: button.hg,v 1.10 2006/08/21 19:07:14 jjongsma Exp $ */
 
/* box.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 <gtkmm/bin.h>
#include <gtkmm/stockid.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkButton GtkButton;
typedef struct _GtkButtonClass GtkButtonClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{ class Button_Class; } // namespace Gtk
namespace Gtk
{
 
namespace Stock { struct BuiltinStockID; }
 
// TODO: Inherit/Implement Activatable when we can break ABI.
 
class Button : public Bin
{
  public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef Button CppObjectType;
  typedef Button_Class CppClassType;
  typedef GtkButton BaseObjectType;
  typedef GtkButtonClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
  virtual ~Button();
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
private:
  friend class Button_Class;
  static CppClassType button_class_;
 
  // noncopyable
  Button(const Button&);
  Button& operator=(const Button&);
 
protected:
  explicit Button(const Glib::ConstructParams& construct_params);
  explicit Button(GtkButton* 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
 
  GtkButton*       gobj()       { return reinterpret_cast<GtkButton*>(gobject_); }
 
  const GtkButton* gobj() const { return reinterpret_cast<GtkButton*>(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_pressed();
  virtual void on_released();
  virtual void on_clicked();
  virtual void on_enter();
  virtual void on_leave();
  virtual void on_activate();
 
 
private:
 
public:
 
  Button();
 
 
  explicit Button(const Glib::ustring& label, bool mnemonic = false);
 
  explicit Button(const StockID& stock_id);
 
 
#ifndef GTKMM_DISABLE_DEPRECATED
 
  void pressed();
#endif // GTKMM_DISABLE_DEPRECATED
 
 
#ifndef GTKMM_DISABLE_DEPRECATED
 
  void released();
#endif // GTKMM_DISABLE_DEPRECATED
 
 
  void clicked();
  
#ifndef GTKMM_DISABLE_DEPRECATED
 
  void enter();
#endif // GTKMM_DISABLE_DEPRECATED
 
 
#ifndef GTKMM_DISABLE_DEPRECATED
 
  void leave();
#endif // GTKMM_DISABLE_DEPRECATED
 
 
  void set_relief(ReliefStyle newstyle);
  
  ReliefStyle get_relief() const;
 
  
  void set_label(const Glib::ustring& label);
  
  Glib::ustring get_label() const;
  
  void set_use_underline(bool use_underline =  true);
  
  bool get_use_underline() const;
  
  void set_use_stock(bool use_stock =  true);
  
  bool get_use_stock() const;
 
  
  void set_focus_on_click(bool focus_on_click =  true);
  
  bool get_focus_on_click() const;
 
  
  void set_alignment(float xalign, float yalign);
  
  void get_alignment(float& xalign, float& yalign);
 
  
  void set_image(Widget& image);
  
  Widget* get_image();
  
  const Widget* get_image() const;
 
  
  void set_image_position(PositionType position);
  
  PositionType get_image_position() const;
 
  
  Glib::RefPtr<Gdk::Window> get_event_window();
  
  Glib::RefPtr<const Gdk::Window> get_event_window() const;
 
  
  Glib::SignalProxy0< void > signal_pressed();
 
  
  Glib::SignalProxy0< void > signal_released();
 
  
  Glib::SignalProxy0< void > signal_clicked();
 
  
  Glib::SignalProxy0< void > signal_enter();
 
  
  Glib::SignalProxy0< void > signal_leave();
 
  
  Glib::SignalProxy0< void > signal_activate();
 
 
  Glib::PropertyProxy< Glib::ustring > property_label() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_label() const;
 
  Glib::PropertyProxy< ReliefStyle > property_relief() ;
 
  Glib::PropertyProxy_ReadOnly< ReliefStyle > property_relief() const;
 
  //Ignored because it's write-only and construct: _WRAP_PROPERTY("use-underline", bool)
  Glib::PropertyProxy< bool > property_use_stock() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_use_stock() const;
 
  Glib::PropertyProxy< bool > property_focus_on_click() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_focus_on_click() const;
 
  Glib::PropertyProxy< float > property_xalign() ;
 
  Glib::PropertyProxy_ReadOnly< float > property_xalign() const;
 
  Glib::PropertyProxy< float > property_yalign() ;
 
  Glib::PropertyProxy_ReadOnly< float > property_yalign() const;
 
  Glib::PropertyProxy< Gtk::Widget* > property_image() ;
 
  Glib::PropertyProxy_ReadOnly< Gtk::Widget* > property_image() const;
 
  Glib::PropertyProxy< PositionType > property_image_position() ;
 
  Glib::PropertyProxy_ReadOnly< PositionType > property_image_position() const;
 
 
};
 
} // namespace Gtk
 
 
namespace Glib
{
  Gtk::Button* wrap(GtkButton* object, bool take_copy = false);
} //namespace Glib
 
 
#endif /* _GTKMM_BUTTON_H */