TreeMultiItemBase.h

//---------------------------------------------------------------------------
// $RCSfile: TreeMultiItemBase.h $
// $Source: contrib/include/wx/treemultictrl/TreeMultiItemBase.h $
// $Revision: 1.84 $
// $Date: Jul 29, 2007 2:09:31 PM $
//---------------------------------------------------------------------------
// Author:      Jorgen Bodde
// Copyright:   (c) Jorgen Bodde
// License:     wxWidgets License
//---------------------------------------------------------------------------
 
#ifndef __TREEMULTIITEMBASE_HPP_
#define __TREEMULTIITEMBASE_HPP_
 
#ifdef __GNUG__
#pragma interface "TreeMultiItemBase.cpp"
#endif
 
#ifndef WX_PRECOMP
#include <wx/wx.h>
#endif
 
// forward definitions
class TreeMultiItemRoot;
 
class TreeMultiItemWindow;
 
class TreeMultiItemNode;
 
class TreeMultiItemBase {
  protected:
    TreeMultiItemBase(TreeMultiItemNode* parent);
 
    wxString _name;
 
    bool _excluded;
 
    int _type;
 
    int _x, _y;
 
    int _width, _height;
 
#if (CHECKBOXVIEW)
    bool _checkbox;
 
    int _checkboxState;
#endif
 
  public:
    virtual ~TreeMultiItemBase();
 
    // type of tree item
 
    int GetType() const {
        return _type;
    };
 
    TreeMultiItemNode* GetParent() const {
        return _parent;
    };
 
    wxString GetName() const {
        return _name;
    };
 
    void SetName(wxString const& NewName) {
        this->_name = NewName;
    }
 
    virtual TreeMultiItemRoot* IsTreeMultiItemRoot() const {
        return 0;
    };
 
    virtual TreeMultiItemWindow* IsTreeMultiItemWindow() const {
        return 0;
    };
 
    virtual TreeMultiItemNode* IsTreeMultiItemNode() const {
        return 0;
    };
 
    void SetExcluded(bool excluded) {
        _excluded = excluded;
    };
 
    void SetX(int x) {
        _x = x;
    };
 
    int GetX() const {
        return _x;
    };
 
    void SetY(int y) {
        _y = y;
    };
 
    int GetY() const {
        return _y;
    };
 
    void SetHeight(int height) {
        _height = height;
    };
 
    int GetHeight() const {
        return _height;
    };
 
    void SetWidth(int width) {
        _width = width;
    };
 
    int GetWidth() const {
        return _width;
    };
 
    bool IsVisible();
 
    /* Returns if this node is excluded from the tree. If this item
       is a Node, then all kids are excluded as well */
    bool IsExcluded() const {
        return _excluded;
    };
 
    //
    // item selection status handling
 
    bool IsSelected(void) const {
        return this->m_Selected;
    }
 
    void Select(void) {
        this->m_Selected = true;
    }
 
    void ToggleSelection(void) {
        this->m_Selected = !(this->m_Selected);
    }
 
    void Unselect(void) {
        this->m_Selected = false;
    }
 
#if (CHECKBOXVIEW)
    void SetCheckbox(bool value) {
        _checkbox = value;
    };
 
    bool GetCheckbox() const {
        return _checkbox;
    };
 
    virtual void SetCheckboxState(int state) {
        wxCHECK2(state < 3 && state >= 0, return);
        _checkboxState = state;
    };
 
    int GetCheckboxState() const {
        return _checkboxState;
    };
#endif
 
  private:
    TreeMultiItemNode* _parent;
 
    // flags to indicate the status of the item:
    bool m_Selected;
};
 
#endif