mythgenerictree.h

Go to the documentation of this file.

#ifndef MYTHGENERICTREE_H_
#define MYTHGENERICTREE_H_
 
#include <utility>
 
#include <QHash>
#include <QList>
#include <QMap>
#include <QMetaType>
#include <QString>
#include <QStringList>
#include <QVariant>
#include <QVector>
 
#include "mythuiexp.h"
#include "mythuibuttonlist.h"
 
class SortableMythGenericTreeList;
 
using mgtCbFn = QString (*)(const QString &name, void *data);
struct mgtCbInfo
{
    mgtCbFn fn   {nullptr};
    void*   data {nullptr};
};
 
class MUI_PUBLIC MythGenericTree
{
    using IntVector = QVector<int>;
 
  public:
    explicit MythGenericTree(QString a_string = "", int an_int = 0,
                    bool selectable_flag = false);
    virtual ~MythGenericTree();
 
    void ensureSortFields(void);
 
    MythGenericTree *addNode(const QString &a_string, int an_int = 0,
                             bool selectable_flag = false, bool visible = true);
    MythGenericTree *addNode(const QString &a_string, const QString &sortText = "",
                             int an_int = 0, bool selectable_flag = false, bool visible = true);
    MythGenericTree *addNode(MythGenericTree *child);
 
    void DetachParent(void);
 
    void removeNode(MythGenericTree *child);
    void deleteNode(MythGenericTree *child);
 
    MythGenericTree *findLeaf();
    MythGenericTree* findNode(QList<int> route_of_branches);
 
    MythGenericTree *nextSibling(int number_down);
    MythGenericTree *prevSibling(int number_up);
 
    MythGenericTree *getSelectedChild(bool onlyVisible = false) const;
    MythGenericTree *getVisibleChildAt(uint reference) const;
    MythGenericTree *getChildAt(uint reference) const;
    MythGenericTree *getChildByName(const QString &a_name) const;
    MythGenericTree *getChildById(int an_int) const;
 
    QList<MythGenericTree*> *getAllChildren() const;
 
    int getChildPosition(MythGenericTree *child) const;
    int getPosition(void);
 
    QList<int> getRouteById(void);
    QStringList getRouteByString(void);
    QList<MythGenericTree*> getRoute(void);
 
    void setInt(int an_int) { m_int = an_int; }
    int getInt() const { return m_int; }
 
    void setParent(MythGenericTree* a_parent) { m_parent = a_parent; }
    MythGenericTree *getParent(void) const;
 
    void SetText(const QString &text, const QString &name="",
                 const QString &state="");
    void SetTextFromMap(const InfoMap &infoMap, const QString &state="");
    void SetTextCb(mgtCbFn fn, void *data);
    QString GetText(const QString &name="") const;
 
    QString GetSortText() const { return m_sortText; }
    void SetSortText(const QString &text) { m_sortText = text; }
 
    void SetImage(const QString &filename, const QString &name="");
    void SetImageFromMap(const InfoMap &infoMap);
    void SetImageCb(mgtCbFn fn, void *data);
    QString GetImage(const QString &name="") const;
 
    void DisplayState(const QString &state, const QString &name="");
    void DisplayStateFromMap(const InfoMap &infoMap);
    void SetStateCb(mgtCbFn fn, void *data);
    QString GetState(const QString &name="") const;
 
    void SetData(QVariant data) { m_data = std::move(data); }
    QVariant GetData(void) const { return m_data; }
 
    int childCount(void) const;
    uint visibleChildCount() const { return m_visibleCount; }
    int siblingCount(void) const;
 
    int currentDepth(void);
 
    void setSelectable(bool flag) { m_selectable = flag; }
    bool isSelectable() const { return m_selectable; }
 
    void SetVisible(bool visible);
    bool IsVisible() const { return m_visible; }
 
    void IncVisibleCount() { m_visibleCount++; }
    void DecVisibleCount() { m_visibleCount--; }
 
    void becomeSelectedChild(void);
    void setSelectedChild(MythGenericTree* a_node) { m_selectedSubnode = a_node; }
 
    void sortByString();
    void sortBySelectable();
    void deleteAllChildren();
 
    // only changes m_subnodes.  resort it if you want the others to change
    void MoveItemUpDown(MythGenericTree *item, bool flag);
 
    virtual MythUIButtonListItem *CreateListButton(MythUIButtonList *list);
 
  private:
    void reorderSubnodes(void);
 
    QString m_text;
    QString m_sortText;
    QMap<QString, TextProperties> m_strings;
    InfoMap m_imageFilenames;
    InfoMap m_states;
    mgtCbInfo m_textCb;
    mgtCbInfo m_imageCb;
    mgtCbInfo m_stateCb;
    int      m_int                          {0};
    QVariant m_data                         {0};
    uint     m_visibleCount                 {0};
 
    SortableMythGenericTreeList *m_subnodes {nullptr};
 
    MythGenericTree *m_selectedSubnode      {nullptr};
    MythGenericTree *m_parent               {nullptr};
 
    bool m_selectable                       {false};
    bool m_visible                          {true};
};
 
Q_DECLARE_METATYPE(MythGenericTree*)
 
#endif