13
0
livetrax/libs/gtkmm2/gtk/gtkmm/scalebutton.h
Paul Davis 449aab3c46 rollback to 3428, before the mysterious removal of libs/* at 3431/3432
git-svn-id: svn://localhost/ardour2/branches/3.0@3435 d708f5d6-7413-0410-9779-e7cbd77b26cf
2008-06-02 21:41:35 +00:00

265 lines
8.0 KiB
C++

// -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _GTKMM_SCALEBUTTON_H
#define _GTKMM_SCALEBUTTON_H
#include <glibmm.h>
/* $Id: scalebutton.hg,v 1.5 2005/11/30 14:10:49 murrayc Exp $ */
/* scalebutton.h
*
* Copyright (C) 2007 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library 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/button.h>
#include <gtkmm/adjustment.h>
#include <gtkmm/enums.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkScaleButton GtkScaleButton;
typedef struct _GtkScaleButtonClass GtkScaleButtonClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gtk
{ class ScaleButton_Class; } // namespace Gtk
namespace Gtk
{
/** A button which pops up a scale widget.
*
* This kind of widget is commonly used for volume controls in multimedia
* applications, and there is a Gtk::VolumeButton subclass that is tailored
* for this use case.
*
* @ingroup Widgets
* @newin2p12
*/
class ScaleButton : public Button
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef ScaleButton CppObjectType;
typedef ScaleButton_Class CppClassType;
typedef GtkScaleButton BaseObjectType;
typedef GtkScaleButtonClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
virtual ~ScaleButton();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
friend class ScaleButton_Class;
static CppClassType scalebutton_class_;
// noncopyable
ScaleButton(const ScaleButton&);
ScaleButton& operator=(const ScaleButton&);
protected:
explicit ScaleButton(const Glib::ConstructParams& construct_params);
explicit ScaleButton(GtkScaleButton* 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
///Provides access to the underlying C GtkObject.
GtkScaleButton* gobj() { return reinterpret_cast<GtkScaleButton*>(gobject_); }
///Provides access to the underlying C GtkObject.
const GtkScaleButton* gobj() const { return reinterpret_cast<GtkScaleButton*>(gobject_); }
public:
//C++ methods used to invoke GTK+ virtual functions:
#ifdef GLIBMM_VFUNCS_ENABLED
#endif //GLIBMM_VFUNCS_ENABLED
protected:
//GTK+ Virtual Functions (override these to change behaviour):
#ifdef GLIBMM_VFUNCS_ENABLED
#endif //GLIBMM_VFUNCS_ENABLED
//Default Signal Handlers::
#ifdef GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
virtual void on_value_changed(double value);
#endif //GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
private:
public:
explicit ScaleButton(IconSize size, double min, double max, double step, const Glib::StringArrayHandle& icons);
/** Sets the icons to be used by the scale button.
* For details, see the Gtk::ScaleButton:icons property.
*
* Since 2.12
* @param icons A <tt>0</tt>-terminated array of icon names.
*/
void set_icons(const Glib::StringArrayHandle& icons);
/** Gets the current value of the scale button.
* @return Current value of the scale button
*
* @newin2p12.
*/
double get_value() const;
/** Sets the current value of the scale; if the value is outside
* the minimum or maximum range values, it will be clamped to fit
* inside them. The scale button emits the Gtk::ScaleButton::value-changed
* signal if the value changes.
*
* @newin2p12
* @param value New value of the scale button.
*/
void set_value(double value);
/** Gets the Gtk::Adjustment associated with the Gtk::ScaleButton's scale.
* See Gtk::Range::get_adjustment() for details.
* @return The adjustment associated with the scale
*
* @newin2p12.
*/
Gtk::Adjustment* get_adjustment();
/** Gets the Gtk::Adjustment associated with the Gtk::ScaleButton's scale.
* See Gtk::Range::get_adjustment() for details.
* @return The adjustment associated with the scale
*
* @newin2p12.
*/
Gtk::Adjustment* get_adjustment() const;
/** Sets the Gtk::Adjustment to be used as a model
* for the Gtk::ScaleButton's scale.
* See Gtk::Range::set_adjustment() for details.
*
* @newin2p12
* @param adjustment A Gtk::Adjustment.
*/
void set_adjustment(Gtk::Adjustment& adjustment);
/**
* @par Prototype:
* <tt>void on_my_%value_changed(double value)</tt>
*/
Glib::SignalProxy1< void,double > signal_value_changed();
//Ignore key-binding signals:
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The value of the scale.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy<double> property_value() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The value of the scale.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<double> property_value() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The icon size.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy<IconSize> property_size() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The icon size.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<IconSize> property_size() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The GtkAdjustment that contains the current value of this scale button object.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy<Adjustment*> property_adjustment() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The GtkAdjustment that contains the current value of this scale button object.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<Adjustment*> property_adjustment() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
};
} // namespace Gtk
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gtk::ScaleButton
*/
Gtk::ScaleButton* wrap(GtkScaleButton* object, bool take_copy = false);
} //namespace Glib
#endif /* _GTKMM_SCALEBUTTON_H */