// -*- c++ -*- // Generated by gtkmmproc -- DO NOT MODIFY! #ifndef _GTKMM_CHECKMENUITEM_H #define _GTKMM_CHECKMENUITEM_H #include /* $Id$ */ /* checkmenuitem.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 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 #ifndef DOXYGEN_SHOULD_SKIP_THIS typedef struct _GtkCheckMenuItem GtkCheckMenuItem; typedef struct _GtkCheckMenuItemClass GtkCheckMenuItemClass; #endif /* DOXYGEN_SHOULD_SKIP_THIS */ namespace Gtk { class CheckMenuItem_Class; } // namespace Gtk namespace Gtk { /** A menu item that maintains the state of a boolean value in addition to a Gtk::MenuItem's usual role in activating application code. * A check box indicating the state of the boolean value is displayed at the left side of the Gtk::MenuItem. * Activating the Gtk::MenuItem toggles the value. * @ingroup Widgets * @ingroup Menus */ class CheckMenuItem : public MenuItem { public: #ifndef DOXYGEN_SHOULD_SKIP_THIS typedef CheckMenuItem CppObjectType; typedef CheckMenuItem_Class CppClassType; typedef GtkCheckMenuItem BaseObjectType; typedef GtkCheckMenuItemClass BaseClassType; #endif /* DOXYGEN_SHOULD_SKIP_THIS */ virtual ~CheckMenuItem(); #ifndef DOXYGEN_SHOULD_SKIP_THIS private: friend class CheckMenuItem_Class; static CppClassType checkmenuitem_class_; // noncopyable CheckMenuItem(const CheckMenuItem&); CheckMenuItem& operator=(const CheckMenuItem&); protected: explicit CheckMenuItem(const Glib::ConstructParams& construct_params); explicit CheckMenuItem(GtkCheckMenuItem* 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. GtkCheckMenuItem* gobj() { return reinterpret_cast(gobject_); } ///Provides access to the underlying C GtkObject. const GtkCheckMenuItem* 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:: virtual void on_toggled(); private: public: CheckMenuItem(); explicit CheckMenuItem(const Glib::ustring& label, bool mnemonic = false); void set_active(bool state = true); /** Returns whether the check menu item is active. See * set_active(). * @return true if the menu item is checked. */ bool get_active() const; void toggled(); /** If the user has selected a range of elements (such as some text or * spreadsheet cells) that are affected by a boolean setting, and the * current values in that range are inconsistent, you may want to * display the check in an "in between" state. This function turns on * "in between" display. Normally you would turn off the inconsistent * state again if the user explicitly selects a setting. This has to be * done manually, set_inconsistent() only affects * visual appearance, it doesn't affect the semantics of the widget. * @param setting true to display an "inconsistent" third state check. */ void set_inconsistent(bool setting = true); /** Retrieves the value set by set_inconsistent(). * @return true if inconsistent. */ bool get_inconsistent() const; /** Sets whether @a check_menu_item is drawn like a Gtk::RadioMenuItem * * Since: 2.4 * @param draw_as_radio Whether @a check_menu_item is drawn like a Gtk::RadioMenuItem. */ void set_draw_as_radio(bool draw_as_radio = true); /** Returns whether @a check_menu_item looks like a Gtk::RadioMenuItem * @return Whether @a check_menu_item looks like a Gtk::RadioMenuItem * * Since: 2.4. */ bool get_draw_as_radio() const; /** Triggered when the item changes state * (Note : changing the item's state with set_active() will also trigger * this signal) */ Glib::SignalProxy0< void > signal_toggled(); /** Whether the menu item is checked. * * 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 property_active() ; /** Whether the menu item is checked. * * 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 property_active() const; /** Whether to display an inconsistent state. * * 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 property_inconsistent() ; /** Whether to display an inconsistent state. * * 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 property_inconsistent() const; /** Whether the menu item looks like a radio menu item. * * 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 property_draw_as_radio() ; /** Whether the menu item looks like a radio menu item. * * 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 property_draw_as_radio() const; protected: /** Triggered when the item is redrawn (e.g.after being toggled) * Overload this signal if you want to implement your own check item * look. Otherwise, you most likely don't care about it. * The GdkRectangle specifies the area of the widget which will get * redrawn. */ virtual void draw_indicator_vfunc(GdkRectangle* area); }; } /* namespace Gtk */ namespace Glib { /** @relates Gtk::CheckMenuItem * @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. */ Gtk::CheckMenuItem* wrap(GtkCheckMenuItem* object, bool take_copy = false); } #endif /* _GTKMM_CHECKMENUITEM_H */