TreeModel.h

Go to the documentation of this file.

#ifndef TREEMODEL_H_
#define TREEMODEL_H_

#include <string>

#include <gtk/gtktreemodel.h>
#include <gtk/gtktreeselection.h>

namespace gtkutil
{

    class TreeModel
    {
        public:

            static std::string getString (GtkTreeModel* model, GtkTreeIter* iter, gint colNo);

            static bool getBoolean (GtkTreeModel* model, GtkTreeIter* iter, gint colNo);

            static int getInt (GtkTreeModel* model, GtkTreeIter* iter, gint colNo);

            static gpointer getPointer (GtkTreeModel* model, GtkTreeIter* iter, gint colNo);

            static std::string getSelectedString (GtkTreeSelection* selection, gint colNo);

            static std::string getSelectedParentString (GtkTreeSelection* sel, gint colNo);

            static bool getSelectedBoolean (GtkTreeSelection* selection, gint colNo);

            static gpointer getSelectedPointer (GtkTreeSelection* selection, gint colNo);

            static gboolean equalFuncStringContains (GtkTreeModel* model, gint column, const gchar* key,
                    GtkTreeIter* iter, gpointer search_data);

            /* Local object that walks the GtkTreeModel and obtains a GtkTreePath locating
             * the given name. The gtk_tree_model_foreach function requires a pointer to
             * a function, which in this case is a static member of the walker object that
             * accepts a void* pointer to the instance (like other GTK callbacks).
             */
            class SelectionFinder
            {

                    // String containing the name to highlight
                    std::string _selection;

                    // An integer to search for (alternative to the string above)
                    int _needle;

                    // The GtkTreePath* pointing to the required texture
                    GtkTreePath* _path;

                    // The GtkTreeModel that has been searched by forEach()
                    GtkTreeModel* _model;

                    // The column index to be searched
                    int _column;

                    // TRUE, if this should search for an integer instead of a string
                    bool _searchForInt;

                public:

                    // Constructor to search for strings
                    SelectionFinder (const std::string& selection, int column);

                    // Constructor to search for integers
                    SelectionFinder (int needle, int column);

                    // Retrieve the found TreePath, which may be NULL if the texture was not
                    // found
                    GtkTreePath* getPath ();

                    GtkTreeIter getIter ();

                    // Static callback for GTK
                    static gboolean
                            forEach (GtkTreeModel* model, GtkTreePath* path, GtkTreeIter* iter, gpointer vpSelf);

            }; // class SelectionFinder
    };

} // namespace gtkutil

#endif /*TREEMODEL_H_*/