/*
 # ---------------------------------------------------------------------
 #
 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
 #                        pour la SantÈ)
 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
 #
 #  This software is governed by the CeCILL-B license under French law and
 #  abiding by the rules of distribution of free software. You can  use,
 #  modify and/ or redistribute the software under the terms of the CeCILL-B
 #  license as circulated by CEA, CNRS and INRIA at the following URL
 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
 #  or in the file LICENSE.txt.
 #
 #  As a counterpart to the access to the source code and  rights to copy,
 #  modify and redistribute granted by the license, users are provided only
 #  with a limited warranty  and the software's author,  the holder of the
 #  economic rights,  and the successive licensors  have only  limited
 #  liability.
 #
 #  The fact that you are presently reading this means that you have had
 #  knowledge of the CeCILL-B license and that you accept its terms.
 # ------------------------------------------------------------------------ */


//---------------------------------------------------------------------------
// $RCSfile: TreeMultiItemNode.h,v $
// $Source: /cvs/creatis/bbtk/kernel/src/ThirdParty/wx/treemultictrl/TreeMultiItemNode.h,v $
// $Revision: 1.2 $
// $Date: 2012/11/16 08:49:16 $
//---------------------------------------------------------------------------
// Author:      Jorgen Bodde
// Copyright:   (c) Jorgen Bodde
// License:     wxWidgets License
//---------------------------------------------------------------------------

#ifndef __TREEMULTIITEMNODE_HPP_
#define __TREEMULTIITEMNODE_HPP_

#ifdef __GNUG__
    #pragma interface "TreeMultiItemNode.cpp"
#endif

#ifndef WX_PRECOMP
    #include "wx/wx.h"
#endif
#include "wx/treebase.h"


#include <wx/dynarray.h>
#include "TreeMultiItemBase.h"
#include "TreeMultiItemWindow.h"

/** TreeMultiItemNode
  * This class is the element class for WX_OBJ_ARRAY and it
  * should be filled with the member variables and methods to
  * manipulate each object inside the object array.
  *
  * See wxArray for all base methods manipulating the array
  * Clear() can be used to safely delete all objects.
  */

// declare the array class here

WX_DECLARE_OBJARRAY(TreeMultiItemBase, TreeMultiItemBaseArray);

class TreeMultiItemNode : public TreeMultiItemBase
{
private:
	TreeMultiItemBaseArray _items;

	/** Caption of this node. */
	wxString _caption;

	/** Indicates if this node is expanded (true) or collapsed (false) */
	bool _nodeExpanded;

 /** visual attributes of the node */
  wxTreeItemAttr m_Attributes;

public:
	TreeMultiItemNode(TreeMultiItemNode *parent, const wxString &caption = wxEmptyString, const wxString &name = wxEmptyString);
	virtual ~TreeMultiItemNode();

	// isClass method
	virtual TreeMultiItemNode *IsTreeMultiItemNode() const {
		return (TreeMultiItemNode *)this;
	};
	
	// add methods
	void AddNode(TreeMultiItemBase *node);
	void InsertNode(TreeMultiItemBase* NodePtr, size_t Position);

	// delete methods
	void Clear();
	void DeleteNode(TreeMultiItemBase *node);
	void DeleteNode(int index);
	TreeMultiItemBase *RemoveNode(TreeMultiItemBase *node);
	TreeMultiItemBase *RemoveNode(int index);

	// get methods
	int GetNodeCount() const;
	TreeMultiItemBase *GetNode(int index) const;
	int Index(TreeMultiItemBase *node,  bool searchFromEnd = false) const;
	TreeMultiItemBase *GetNodeNext(int &cookie) const;
	
	TreeMultiItemBase* First() const;
	TreeMultiItemBase* Last() const;

	/** Fold function sets or clears the expanded flag. Note when excluded from drawing, this
	    will have no effect on redraw */
	void Fold(bool expand) {
		if(_nodeExpanded != expand)
			_nodeExpanded = expand;
	};

	/** Return caption */
	const wxString &GetCaption() const {
		return _caption;
	};

	/** Returns true if the node is expanded. Subnodes can still be collapsed though */
	bool IsExpanded() const {
		return _nodeExpanded;
	};


};

#endif