FxUITreeView.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2023 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted, 
// provided that the above copyright notice appears in all copies and 
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting 
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS. 
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH 
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
#include "FxUIBaseView.h"
#include "../../sdk/Core/FxUIAbstractItemModel.h"
#include "../../sdk/Core/FxUIModelIndex.h"
 
class COMMONUI_API CFxUITreeView : public CFxUIBaseView
{
public:
 
    enum UIHeaderAlignment
    {
        AlignLeft = 0x0001, 
        AlignRight = 0x0002, 
        AlignHCenter = 0x0004, 
        AlignTop = 0x0020, 
        AlignBottom = 0x0040, 
        AlignVCenter = 0x0080 
    };
 
    enum UISelectionBehavior
    {
        SelectItems, 
        SelectRows, 
        SelectColumns 
    };
 
    enum UISelectionMode
    {
        NoSelection,  
        SingleSelection, 
        MultiSelection, 
        ExtendedSelection, 
                           
        ContiguousSelection 
    };
 
    enum UIHeaderResizeMode
    {
        Interactive, 
        Stretch, 
        Fixed, 
        ResizeToContents, 
        Custom = Fixed 
    };
 
    enum UISelectionFlag {
        NoUpdate = 0x0000, 
        Clear = 0x0001, 
        Select = 0x0002, 
        Deselect = 0x0004, 
        Rows = 0x0020, 
        Columns = 0x0040, 
        ClearAndSelect = Clear | Select 
    };
 
public:
 
    CFxUITreeView();
 
    ~CFxUITreeView();
 
    void setParentNodeIcon( const CFxUIIcon & icon );
 
    void setChildNodeIcon( const CFxUIIcon & icon );
 
        void setMoveCursorMode(bool bItemMode);
 
    void setHeaderAlignment( CFxUITreeView::UIHeaderAlignment align );
 
    void setHeaderResizeSection( CFxUITreeView::UIHeaderResizeMode mode, int iColumn );
 
    void setHeaderResizeSection( CFxUITreeView::UIHeaderResizeMode mode );
 
    void setHeaderStretchLastSection( bool bEnable );
 
    void setSortingEnabled( bool bEnable );
 
    void setSelectionBehavior( CFxUITreeView::UISelectionBehavior behavior );
 
    void setSelectionMode( CFxUITreeView::UISelectionMode mode );
 
    void setRootIsDecorated( bool bShow );
 
    void setAlternatingRowColors( bool bEnable );
 
    void setColumnWidth( int iColumn, int iWidth );
 
    void setModel( CFxUIAbstractItemModel* model );
 
    CFxUIAbstractItemModel* getModel();
 
    void setCurrentIndex( CFxUIModelIndex index );
 
    CFxUIModelIndex currentIndex() const;
 
    void setAutoScroll( bool bEnable );
 
    void setCollapse( CFxUIModelIndex index );
 
    void setExpand( CFxUIModelIndex index );
 
    void setColumnHidden( int iColumn, bool bHide );
 
    void selectRow( CFxUITreeView::UISelectionFlag flag, CFxUIModelIndex index );
 
    void clearSelection();
 
    void expandAll();
 
    void collapseAll();
 
    void setExpandsOnDoubleClick( bool bEnable );
 
    CFxUISignal<void( const CFxUIModelIndex& )>& itemClicked();
 
    CFxUISignal<void( const CFxUIModelIndex& )>& itemDoubleClicked();
 
    CFxUISignal<void(void)>& selectionChanged();
 
    CFxUISignal< void( int, int ) >& keyWentDown();
 
    CFxUISignal<void( const CFxUIModelIndex& )>& collapsed();
    CFxUISignal<void( const CFxUIModelIndex& )>& expanded();
 
    //...
 
};