1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
|
// -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GTKMM_LISTBOXROW_H
#define _GTKMM_LISTBOXROW_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/* Copyright (C) 2013 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, see <http://www.gnu.org/licenses/>.
*/
#include <gtkmm/bin.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkListBoxRow GtkListBoxRow;
typedef struct _GtkListBoxRowClass GtkListBoxRowClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gtk
{ class ListBoxRow_Class; } // namespace Gtk
namespace Gtk
{
/** See the description of ListBox.
*
* @ingroup Widgets
* @ingroup Containers
*
* @newin{3,10}
*/
class ListBoxRow : public Bin
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef ListBoxRow CppObjectType;
typedef ListBoxRow_Class CppClassType;
typedef GtkListBoxRow BaseObjectType;
typedef GtkListBoxRowClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
virtual ~ListBoxRow();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
friend class ListBoxRow_Class;
static CppClassType listboxrow_class_;
// noncopyable
ListBoxRow(const ListBoxRow&);
ListBoxRow& operator=(const ListBoxRow&);
protected:
explicit ListBoxRow(const Glib::ConstructParams& construct_params);
explicit ListBoxRow(GtkListBoxRow* 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 GtkObject.
GtkListBoxRow* gobj() { return reinterpret_cast<GtkListBoxRow*>(gobject_); }
///Provides access to the underlying C GtkObject.
const GtkListBoxRow* gobj() const { return reinterpret_cast<GtkListBoxRow*>(gobject_); }
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
private:
public:
ListBoxRow();
/** Sets the current header of the ListBoxRow. This is only allowed to be called
* from a ListBox::SlotUpdateHeader. It will replace any existing
* header in the row, and be shown in front of the row in the ListBox.
*
* @newin{3,10}
* @param header The header.
*/
void set_header(Widget& header);
/** Removes the current header, if any. This is only allowed to be called
* from a ListBox::SlotUpdateHeader.
*
* @newin{3,10}
*/
void unset_header();
/** Returns the current header of the ListBoxRow. This can be used
* in a ListBox::SlotUpdateHeader to see if there is a header
* set already, and if so to update the state of it.
*
* @newin{3,10}
* @return The current header, or <tt>0</tt> if none.
*/
Widget* get_header();
/** Returns the current header of the ListBoxRow. This can be used
* in a ListBox::SlotUpdateHeader to see if there is a header
* set already, and if so to update the state of it.
*
* @newin{3,10}
* @return The current header, or <tt>0</tt> if none.
*/
const Widget* get_header() const;
/** Gets the current index of the @a row in its Gtk::ListBox container.
*
* @newin{3,10}
*
* @return The index of the @a row, or -1 if the @a row is not in a listbox.
*/
int get_index() const;
/** Marks @a row as changed, causing any state that depends on this
* to be updated. This affects sorting, filtering and headers.
*
* Note that calls to this method must be in sync with the data
* used for the row functions. For instance, if the list is
* mirroring some external data set, and *two* rows changed in the
* external data set then when you call changed()
* on the first row the sort function must only read the new data
* for the first of the two changed rows, otherwise the resorting
* of the rows will be wrong.
*
* This generally means that if you don’t fully control the data
* model you have to duplicate the data that affects the listbox
* row functions into the row widgets themselves. Another alternative
* is to call invalidate_sort() on any model change,
* but that is more expensive.
*
* @newin{3,10}
*
*/
void changed();
/** Returns whether the child is currently selected in its
* Gtk::ListBox container.
*
* @newin{3,14}
*
* @return <tt>true</tt> if @a row is selected.
*/
bool is_selected() const;
/** Set the Gtk::ListBoxRow::property_selectable() property for this row.
*
* @newin{3,14}
*
* @param selectable <tt>true</tt> to mark the row as selectable.
*/
void set_selectable(bool selectable = true);
/** Gets the value of the Gtk::ListBoxRow::property_selectable() property
* for this row.
*
* @newin{3,14}
*
* @return <tt>true</tt> if the row is selectable.
*/
bool get_selectable() const;
/** Set the Gtk::ListBoxRow::property_activatable() property for this row.
*
* @newin{3,14}
*
* @param activatable <tt>true</tt> to mark the row as activatable.
*/
void set_activatable(bool activatable = true);
/** Gets the value of the Gtk::ListBoxRow::property_activatable() property
* for this row.
*
* @newin{3,14}
*
* @return <tt>true</tt> if the row is activatable.
*/
bool get_activatable() const;
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Whether this row can be selected.
*
* 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 value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_selectable() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Whether this row can be selected.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @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_selectable() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Whether this row can be activated.
*
* 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 value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_activatable() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Whether this row can be activated.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @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_activatable() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
// Action signal
};
} // 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::ListBoxRow
*/
Gtk::ListBoxRow* wrap(GtkListBoxRow* object, bool take_copy = false);
} //namespace Glib
#endif /* _GTKMM_LISTBOXROW_H */
|