+// ----------------------------------------------------------------------------
+// wxGtkTreePath: self-destroying GtkTreePath
+// ----------------------------------------------------------------------------
+
+// Usually this object is initialized with the associated GtkTreePath
+// immediately when it's constructed but it can also be changed later either by
+// using Assign() or by getting the pointer to the internally stored pointer
+// value using ByRef(). The latter should be avoided but is very convenient
+// when using GTK functions with GtkTreePath output parameters.
+class wxGtkTreePath
+{
+public:
+ // Ctor takes ownership of the given path and will free it if non-NULL.
+ wxGtkTreePath(GtkTreePath *path = NULL) : m_path(path) { }
+
+ // Creates a tree path for the given string path.
+ wxGtkTreePath(const gchar *strpath)
+ : m_path(gtk_tree_path_new_from_string(strpath))
+ {
+ }
+
+ // Set the stored pointer if not done by ctor.
+ void Assign(GtkTreePath *path)
+ {
+ wxASSERT_MSG( !m_path, "shouldn't be already initialized" );
+
+ m_path = path;
+ }
+
+ // Return the pointer to the internally stored pointer. This should only be
+ // used to initialize the object by passing it to some GTK function.
+ GtkTreePath **ByRef()
+ {
+ wxASSERT_MSG( !m_path, "shouldn't be already initialized" );
+
+ return &m_path;
+ }
+
+
+ operator GtkTreePath *() const { return m_path; }
+
+ ~wxGtkTreePath() { if ( m_path ) gtk_tree_path_free(m_path); }
+
+private:
+ GtkTreePath *m_path;
+
+ wxDECLARE_NO_COPY_CLASS(wxGtkTreePath);
+};
+
+// ----------------------------------------------------------------------------
+// wxGtkTreePathList: self-destroying list of GtkTreePath objects.
+// ----------------------------------------------------------------------------
+
+class wxGtkTreePathList : public wxGtkList
+{
+public:
+ // Ctor takes ownership of the list.
+ explicit wxGtkTreePathList(GList* list)
+ : wxGtkList(list)
+ {
+ }
+
+ ~wxGtkTreePathList()
+ {
+ // Delete the list contents, wxGtkList will delete the list itself.
+ g_list_foreach(m_list, (GFunc)gtk_tree_path_free, NULL);
+ }
+};
+
+// ----------------------------------------------------------------------------
+// wxGtkTreeSelectionLock: prevent selection from changing during the
+// lifetime of this object
+// ----------------------------------------------------------------------------
+
+// Implementation note: it could be expected that setting the selection
+// function in this class ctor and resetting it back to the old value in its
+// dtor would work. However currently gtk_tree_selection_get_select_function()
+// can't be passed NULL (see https://bugzilla.gnome.org/show_bug.cgi?id=626276)
+// so we can't do this. Instead, we always use the selection function (which
+// imposes extra overhead, albeit minimal one, on all selection operations) and
+// just set/reset the flag telling it whether it should allow or forbid the
+// selection.
+//
+// Also notice that currently only a single object of this class may exist at
+// any given moment. It's just simpler like this and we don't need anything
+// more for now.
+
+extern "C" {
+static
+gboolean wxdataview_selection_func(GtkTreeSelection * WXUNUSED(selection),
+ GtkTreeModel * WXUNUSED(model),
+ GtkTreePath * WXUNUSED(path),
+ gboolean WXUNUSED(path_currently_selected),
+ gpointer data)
+{
+ return data == NULL;
+}
+}
+
+class wxGtkTreeSelectionLock
+{
+public:
+ wxGtkTreeSelectionLock(GtkTreeSelection *selection)
+ : m_selection(selection)
+ {
+ wxASSERT_MSG( !ms_instance, "this class is not reentrant currently" );
+
+ ms_instance = this;
+
+ CheckCurrentSelectionFunc(NULL);
+
+ // Pass some non-NULL pointer as "data" for the callback, it doesn't
+ // matter what it is as long as it's non-NULL.
+ gtk_tree_selection_set_select_function(selection,
+ wxdataview_selection_func,
+ this,
+ NULL);
+ }
+
+ ~wxGtkTreeSelectionLock()
+ {
+ CheckCurrentSelectionFunc(wxdataview_selection_func);
+
+ gtk_tree_selection_set_select_function(m_selection,
+ wxdataview_selection_func,
+ NULL,
+ NULL);
+
+ ms_instance = NULL;
+ }
+
+private:
+ void CheckCurrentSelectionFunc(GtkTreeSelectionFunc func)
+ {
+ // We can only use gtk_tree_selection_get_select_function() with 2.14+
+ // so check for its availability both during compile- and run-time.
+#if GTK_CHECK_VERSION(2, 14, 0)
+#ifndef __WXGTK3__
+ if ( gtk_check_version(2, 14, 0) != NULL )
+ return;
+#endif
+
+ // If this assert is triggered, it means the code elsewhere has called
+ // gtk_tree_selection_set_select_function() but currently doing this
+ // breaks this class so the code here needs to be changed.
+ wxASSERT_MSG
+ (
+ gtk_tree_selection_get_select_function(m_selection) == func,
+ "selection function has changed unexpectedly, review this code!"
+ );
+#endif // GTK+ 2.14+
+
+ wxUnusedVar(func);
+ }
+
+ static wxGtkTreeSelectionLock *ms_instance;
+
+ GtkTreeSelection * const m_selection;
+
+ wxDECLARE_NO_COPY_CLASS(wxGtkTreeSelectionLock);
+};
+
+wxGtkTreeSelectionLock *wxGtkTreeSelectionLock::ms_instance = NULL;
+
projects / wxWidgets.git / blobdiff