/* * gnc-tree-model-commodity.h -- GtkTreeModel implementation to * display commodities in a GtkTreeView. * * Copyright (C) 2003 Jan Arne Petersen * Copyright (C) 2003 David Hampton * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License as * published by the Free Software Foundation; either version 2 of * the License, or (at your option) any later version. * * This program 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 General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, contact: * * Free Software Foundation Voice: +1-617-542-5942 * 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652 * Boston, MA 02110-1301, USA gnu@gnu.org */ /** @addtogroup GUI @{ */ /** @addtogroup GuiTreeModel @{ */ /** @file gnc-tree-model-commodity.h @brief GtkTreeModel implementation for gnucash commodities. @author Jan Arne Petersen @author David Hampton */ #ifndef __GNC_TREE_MODEL_COMMODITY_H #define __GNC_TREE_MODEL_COMMODITY_H #include #include "gnc-tree-model.h" #include "gnc-commodity.h" G_BEGIN_DECLS /* type macros */ #define GNC_TYPE_TREE_MODEL_COMMODITY (gnc_tree_model_commodity_get_type ()) G_DECLARE_FINAL_TYPE (GncTreeModelCommodity, gnc_tree_model_commodity, GNC, TREE_MODEL_COMMODITY, GncTreeModel) #define GNC_TREE_MODEL_COMMODITY_NAME "GncTreeModelCommodity" typedef enum { GNC_TREE_MODEL_COMMODITY_COL_NAMESPACE, GNC_TREE_MODEL_COMMODITY_COL_MNEMONIC, GNC_TREE_MODEL_COMMODITY_COL_USER_SYMBOL, GNC_TREE_MODEL_COMMODITY_COL_FULLNAME, GNC_TREE_MODEL_COMMODITY_COL_PRINTNAME, GNC_TREE_MODEL_COMMODITY_COL_UNIQUE_NAME, GNC_TREE_MODEL_COMMODITY_COL_CUSIP, GNC_TREE_MODEL_COMMODITY_COL_FRACTION, GNC_TREE_MODEL_COMMODITY_COL_QUOTE_FLAG, GNC_TREE_MODEL_COMMODITY_COL_QUOTE_SOURCE, GNC_TREE_MODEL_COMMODITY_COL_QUOTE_TZ, GNC_TREE_MODEL_COMMODITY_COL_LAST_VISIBLE = GNC_TREE_MODEL_COMMODITY_COL_QUOTE_TZ, /* internal hidden columns */ GNC_TREE_MODEL_COMMODITY_COL_VISIBILITY, GNC_TREE_MODEL_COMMODITY_NUM_COLUMNS } GncTreeModelCommodityColumn; /** @name Account Tree Model Constructors @{ */ /** Create a new GtkTreeModel for manipulating gnucash commodities. * * @param book The book that holds these commodities. * * @param ct A pointer to the commodity table to use for this tree. * All namespaces and commodities in this tree will be included. */ GtkTreeModel *gnc_tree_model_commodity_new (QofBook *book, gnc_commodity_table *ct); /** @} */ /** @name Commodity Tree Model Filter Helper Functions @{ */ /** Determine whether or not the specified GtkTreeIter points to a * commodity namespace. This routine should only be called from a * commodity tree view filter function. The model and iter values * will be provided as part of the call to the filter. * * @param model A pointer to the commodity tree model. * * @param iter A GtkTreeIter corresponding to a single item in the * model. * * @return TRUE if the iter points to a commodity namespace, FALSE * otherwise. */ gboolean gnc_tree_model_commodity_iter_is_namespace (GncTreeModelCommodity *model, GtkTreeIter *iter); /** Determine whether or not the specified GtkTreeIter points to a * commodity. This routine should only be called from a commodity * tree view filter function. The model and iter values will be * provided as part of the call to the filter. * * @param model A pointer to the commodity tree model. * * @param iter A GtkTreeIter corresponding to a single item in the * model. * * @return TRUE if the iter points to a commodity, FALSE * otherwise. */ gboolean gnc_tree_model_commodity_iter_is_commodity (GncTreeModelCommodity *model, GtkTreeIter *iter); /** Convert a model/iter pair to a gnucash commodity namespace. This * routine should only be called from a commodity tree view filter * function. The model and iter values will be provided as part of * the call to the filter. * * @param model A pointer to the commodity tree model. * * @param iter A GtkTreeIter corresponding to a single namespace in * the model. * * @return A pointer to the corresponding namespace. */ gnc_commodity_namespace *gnc_tree_model_commodity_get_namespace (GncTreeModelCommodity *model, GtkTreeIter *iter); /** Convert a model/iter pair to a gnucash commodity. This routine * should only be called from a commodity tree view filter function. * The model and iter values will be provided as part of the call to * the filter. * * @param model A pointer to the commodity tree model. * * @param iter A GtkTreeIter corresponding to a single commodity in * the model. * * @return A pointer to the corresponding commodity. */ gnc_commodity *gnc_tree_model_commodity_get_commodity (GncTreeModelCommodity *model, GtkTreeIter *iter); /** @} */ /** @name Commodity Tree Model Lookup Functions @{ */ /** Convert a commodity namespace pointer into a GtkTreeIter. * * @param model A pointer to the commodity tree model. * * @param namespace A pointer to the gnucash commodity namespace. * * @param iter A pointer to a GtkTreeIter. This iter will be filled * in to point where the namespace appears in the commodity tree. * * @return TRUE if the returned iter is valid, FALSE otherwise. */ gboolean gnc_tree_model_commodity_get_iter_from_namespace (GncTreeModelCommodity *model, gnc_commodity_namespace *name_space, GtkTreeIter *iter); /** Convert a commodity pointer into a GtkTreeIter. * * @param model A pointer to the commodity tree model. * * @param commodity A pointer to the gnucash commodity. * * @param iter A pointer to a GtkTreeIter. This iter will be filled * in to point where the commodity appears in the commodity tree. * * @return TRUE if the returned iter is valid, FALSE otherwise. */ gboolean gnc_tree_model_commodity_get_iter_from_commodity (GncTreeModelCommodity *model, gnc_commodity *commodity, GtkTreeIter *iter); /** Convert a commodity pointer into a GtkTreePath. * * @param model A pointer to the commodity tree model. * * @param commodity A pointer to the gnucash commodity. * * @return A pointer to a GtkTreePath describing the location of this * commodity. This pointer must be freed by the caller when no * longer needed. This routine will return NULL if the commodity * does not exist in the tree. */ GtkTreePath *gnc_tree_model_commodity_get_path_from_commodity (GncTreeModelCommodity *model, gnc_commodity *commodity); /** @} */ G_END_DECLS #endif /* __GNC_TREE_MODEL_COMMODITY_H */ /** @} */ /** @} */