// Generated by gmmproc 2.54.0 -- DO NOT MODIFY!
#ifndef _GTKMM_ACTIVATABLE_H
#define _GTKMM_ACTIVATABLE_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/* Copyright (C) 2009 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#include <gtkmm/action.h>
#include <glibmm/interface.h>
//TODO: Do this when we can stop using this as a base class elsewhere, when we break ABI:
//_IS_DEPRECATED // This whole file is deprecated.
#ifndef DOXYGEN_SHOULD_SKIP_THIS
extern "C"
{
typedef struct _GtkActivatableIface GtkActivatableIface;
}
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
using GtkActivatable = struct _GtkActivatable;
using GtkActivatableClass = struct _GtkActivatableClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{ class Activatable_Class; } // namespace Gtk
#endif // DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{
/** %Activatable widgets can be connected to a Gtk::Action and reflect the state
* of the action. An %Activatable can also provide feedback through its action,
* as it is responsible for activating the related action.
*
* @newin{2,16}
*
* @deprecated Use Gio::Action instead of Gtk::Action.
* Gtk::Actionable is roughly a replacement for %Gtk::Activatable.
*/
class Activatable : public Glib::Interface
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
using CppObjectType = Activatable;
using CppClassType = Activatable_Class;
using BaseObjectType = GtkActivatable;
using BaseClassType = GtkActivatableIface;
// noncopyable
Activatable(const Activatable&) = delete;
Activatable& operator=(const Activatable&) = delete;
private:
friend class Activatable_Class;
static CppClassType activatable_class_;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
protected:
/**
* You should derive from this class to use it.
*/
Activatable();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** Called by constructors of derived classes. Provide the result of
* the Class init() function to ensure that it is properly
* initialized.
*
* @param interface_class The Class object for the derived type.
*/
explicit Activatable(const Glib::Interface_Class& interface_class);
public:
// This is public so that C++ wrapper instances can be
// created for C instances of unwrapped types.
// For instance, if an unexpected C type implements the C interface.
explicit Activatable(GtkActivatable* castitem);
protected:
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
Activatable(Activatable&& src) noexcept;
Activatable& operator=(Activatable&& src) noexcept;
~Activatable() noexcept override;
static void add_interface(GType gtype_implementer);
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GtkActivatable* gobj() { return reinterpret_cast<GtkActivatable*>(gobject_); }
///Provides access to the underlying C GObject.
const GtkActivatable* gobj() const { return reinterpret_cast<GtkActivatable*>(gobject_); }
private:
public:
#ifndef GTKMM_DISABLE_DEPRECATED
/** This is a utility function for Gtk::Activatable implementors.
*
* When implementing Gtk::Activatable you must call this when
* handling changes of the Gtk::Activatable::property_related_action(), and
* you must also use this to break references in Object->dispose().
*
* This function adds a reference to the currently set related
* action for you, it also makes sure the Gtk::Activatable->update()
* method is called when the related Gtk::Action properties change
* and registers to the action’s proxy list.
*
* > Be careful to call this before setting the local
* > copy of the Gtk::Action property, since this function uses
* > get_related_action() to retrieve the
* > previous action.
*
* @newin{2,16}
*
* Deprecated: 3.10
*
* @deprecated There is no corresponding replacement when using Gio::Action.
*
* @param action The Gtk::Action to set.
*/
void do_set_related_action(const Glib::RefPtr<Action>& action);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Gets the related Gtk::Action for @a activatable.
*
* @newin{2,16}
*
* Deprecated: 3.10
*
* @deprecated Use Gtk::Actionable::get_action_name() on Gtk::Actionable widgets instead.
*
* @return The related Gtk::Action if one is set.
*/
Glib::RefPtr<Action> get_related_action();
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Gets the related Gtk::Action for @a activatable.
*
* @newin{2,16}
*
* Deprecated: 3.10
*
* @deprecated Use Gtk::Actionable::get_action_name() on Gtk::Actionable widgets instead.
*
* @return The related Gtk::Action if one is set.
*/
Glib::RefPtr<const Action> get_related_action() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Gets whether this activatable should reset its layout
* and appearance when setting the related action or when
* the action changes appearance.
*
* @newin{2,16}
*
* Deprecated: 3.10
*
* @deprecated There is no corresponding replacement when using Gio::Action.
*
* @return Whether @a activatable uses its actions appearance.
*/
bool get_use_action_appearance() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** This is called to update the activatable completely, this is called
* internally when the Gtk::Activatable::property_related_action() property is set
* or unset and by the implementing class when
* Gtk::Activatable::property_use_action_appearance() changes.
*
* @newin{2,16}
*
* Deprecated: 3.10
*
* @deprecated There is no corresponding replacement when using Gio::Action.
*
* @param action The related Gtk::Action or <tt>nullptr</tt>.
*/
void sync_action_properties(const Glib::RefPtr<Action>& action);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Sets the related action on the @a activatable object.
*
* > Gtk::Activatable implementors need to handle the Gtk::Activatable::property_related_action()
* > property and call do_set_related_action() when it changes.
*
* @newin{2,16}
*
* Deprecated: 3.10
*
* @deprecated Use Gtk::Actionable::set_action_name() on Gtk::Actionable widgets instead.
*
* @param action The Gtk::Action to set.
*/
void set_related_action(const Glib::RefPtr<Action>& action);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Sets whether this activatable should reset its layout and appearance
* when setting the related action or when the action changes appearance
*
* > Gtk::Activatable implementors need to handle the
* > Gtk::Activatable::property_use_action_appearance() property and call
* > sync_action_properties() to update @a activatable
* > if needed.
*
* @newin{2,16}
*
* Deprecated: 3.10
*
* @deprecated There is no corresponding replacement when using Gio::Action.
*
* @param use_appearance Whether to use the actions appearance.
*/
void set_use_action_appearance(bool use_appearance = true);
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** The action that this activatable will activate and receive
* updates from for various states and possibly appearance.
*
* > Gtk::Activatable implementors need to handle the this property and
* > call Gtk::Activatable::do_set_related_action() when it changes.
*
* @newin{2,16}
*
* Deprecated: 3.10
*
* @deprecated Use Gtk::Actionable::property_action_name() on Gtk::Actionable widgets instead.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::RefPtr<Action> > property_related_action() ;
/** The action that this activatable will activate and receive
* updates from for various states and possibly appearance.
*
* > Gtk::Activatable implementors need to handle the this property and
* > call Gtk::Activatable::do_set_related_action() when it changes.
*
* @newin{2,16}
*
* Deprecated: 3.10
*
* @deprecated Use Gtk::Actionable::property_action_name() on Gtk::Actionable widgets instead.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Action> > property_related_action() const;
#endif // GTKMM_DISABLE_DEPRECATED
#ifndef GTKMM_DISABLE_DEPRECATED
/** Whether this activatable should reset its layout
* and appearance when setting the related action or when
* the action changes appearance.
*
* See the Gtk::Action documentation directly to find which properties
* should be ignored by the Gtk::Activatable when this property is <tt>false</tt>.
*
* > Gtk::Activatable implementors need to handle this property
* > and call Gtk::Activatable::sync_action_properties() on the activatable
* > widget when it changes.
*
* @newin{2,16}
*
* Deprecated: 3.10
*
* @deprecated There is no corresponding replacement when using Gio::Action.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_use_action_appearance() ;
/** Whether this activatable should reset its layout
* and appearance when setting the related action or when
* the action changes appearance.
*
* See the Gtk::Action documentation directly to find which properties
* should be ignored by the Gtk::Activatable when this property is <tt>false</tt>.
*
* > Gtk::Activatable implementors need to handle this property
* > and call Gtk::Activatable::sync_action_properties() on the activatable
* > widget when it changes.
*
* @newin{2,16}
*
* Deprecated: 3.10
*
* @deprecated There is no corresponding replacement when using Gio::Action.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_use_action_appearance() const;
#endif // GTKMM_DISABLE_DEPRECATED
virtual void update_vfunc(const Glib::RefPtr<Action>& action, const Glib::ustring& property_name);
virtual void sync_action_properties_vfunc(const Glib::RefPtr<Action>& action);
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
};
} // 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::Activatable
*/
Glib::RefPtr<Gtk::Activatable> wrap(GtkActivatable* object, bool take_copy = false);
} // namespace Glib
#endif /* _GTKMM_ACTIVATABLE_H */