// Generated by gmmproc 2.66.7 -- DO NOT MODIFY! #ifndef _GTKMM_LINKBUTTON_H #define _GTKMM_LINKBUTTON_H #include #include /* * Copyright (C) 2006 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 #ifndef DOXYGEN_SHOULD_SKIP_THIS using GtkLinkButton = struct _GtkLinkButton; using GtkLinkButtonClass = struct _GtkLinkButtonClass; #endif /* DOXYGEN_SHOULD_SKIP_THIS */ #ifndef DOXYGEN_SHOULD_SKIP_THIS namespace Gtk { class GTKMM_API LinkButton_Class; } // namespace Gtk #endif //DOXYGEN_SHOULD_SKIP_THIS namespace Gtk { /** Create buttons bound to a URL. * * A Gtk::LinkButton is a Gtk::Button with a hyperlink, similar to the one * used by web browsers, which triggers an action when clicked. It is useful * to show quick links to resources. * * The URI bound to a Gtk::LinkButton can be set specifically using set_uri(), * and retrieved using get_uri(). * By default, Gtk::LinkButton calls gtk_show_uri() when the button is clicked. * This behaviour can be overridden by connecting to the activate_link signal and * returning true from the signal handler. * * The LinkButton widget looks like this: * @image html linkbutton1.png * * @newin{2,10} * @ingroup Widgets */ class GTKMM_API LinkButton : public Button { public: #ifndef DOXYGEN_SHOULD_SKIP_THIS typedef LinkButton CppObjectType; typedef LinkButton_Class CppClassType; typedef GtkLinkButton BaseObjectType; typedef GtkLinkButtonClass BaseClassType; #endif /* DOXYGEN_SHOULD_SKIP_THIS */ LinkButton(LinkButton&& src) noexcept; LinkButton& operator=(LinkButton&& src) noexcept; // noncopyable LinkButton(const LinkButton&) = delete; LinkButton& operator=(const LinkButton&) = delete; ~LinkButton() noexcept override; #ifndef DOXYGEN_SHOULD_SKIP_THIS private: friend class GTKMM_API LinkButton_Class; static CppClassType linkbutton_class_; protected: explicit LinkButton(const Glib::ConstructParams& construct_params); explicit LinkButton(GtkLinkButton* castitem); #endif /* DOXYGEN_SHOULD_SKIP_THIS */ public: /** 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. GtkLinkButton* gobj() { return reinterpret_cast(gobject_); } /// Provides access to the underlying C GObject. const GtkLinkButton* gobj() const { return reinterpret_cast(gobject_); } public: //C++ methods used to invoke GTK+ virtual functions: protected: //GTK+ Virtual Functions (override these to change behaviour): //Default Signal Handlers:: /// This is a default handler for the signal signal_activate_link(). virtual bool on_activate_link(); private: public: LinkButton(); explicit LinkButton(const Glib::ustring& uri); explicit LinkButton(const Glib::ustring& uri, const Glib::ustring& label); /** Retrieves the URI set using set_uri(). * * @newin{2,10} * * @return A valid URI. The returned string is owned by the link button * and should not be modified or freed. */ Glib::ustring get_uri() const; /** Sets @a uri as the URI where the Gtk::LinkButton points. As a side-effect * this unsets the “visited” state of the button. * * @newin{2,10} * * @param uri A valid URI. */ void set_uri(const Glib::ustring& uri); /** Retrieves the “visited” state of the URI where the Gtk::LinkButton * points. The button becomes visited when it is clicked. If the URI * is changed on the button, the “visited” state is unset again. * * The state may also be changed using set_visited(). * * @newin{2,14} * * @return true if the link has been visited, false otherwise. */ bool get_visited() const; /** Sets the “visited” state of the URI where the Gtk::LinkButton * points. See get_visited() for more details. * * @newin{2,14} * * @param visited The new “visited” state. */ void set_visited(bool visited = true); /** The URI bound to this button. * * @newin{2,10} * * Default value: "" * * @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::ustring > property_uri() ; /** The URI bound to this button. * * @newin{2,10} * * Default value: "" * * @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::ustring > property_uri() const; /** The 'visited' state of this button. A visited link is drawn in a * different color. * * @newin{2,14} * * Default value: false * * @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_visited() ; /** The 'visited' state of this button. A visited link is drawn in a * different color. * * @newin{2,14} * * Default value: false * * @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_visited() const; /** * @par Slot Prototype: * bool on_my_%activate_link() * * Flags: Run Last * * The signal_activate_link() signal is emitted each time the Gtk::LinkButton * has been clicked. * * The default handler will call gtk_show_uri_on_window() with the URI stored inside * the Gtk::LinkButton::property_uri() property. * * To override the default behavior, you can connect to the signal_activate_link() * signal and stop the propagation of the signal by returning true from * your handler. */ Glib::SignalProxy< bool > signal_activate_link(); }; } // 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::LinkButton */ GTKMM_API Gtk::LinkButton* wrap(GtkLinkButton* object, bool take_copy = false); } //namespace Glib #endif /* _GTKMM_LINKBUTTON_H */