FxUIListBox.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"
 
class COMMONUI_API CFxUIListBox : public CFxUIBaseView
{
public:
    enum SelectionMode
    {
        SingleSelection, //When the user selects an item, any already-selected item becomes unselected, and the user cannot unselect the selected item by clicking on it.
        MultiSelection, //When the user selects an item in the usual way, the selection status of that item is toggled and the other items are left alone.
    };
    
    CFxUIListBox();
 
    ~CFxUIListBox();
    
    void addItem( const CFxUIString& item );
 
    int count() const;
 
    void clear();
    
    void setSelectionMode(SelectionMode mode);
    
    CFxUIStringList selectedItems () const;
 
    int row( const CFxUIString& ) const;
 
    int currentRow() const;
 
    void clearSelection();
 
    void setItemSelected( int index, bool );
 
    void setItemData( int index, const CFxUIVariant& data, int role = Qt::UserRole );
 
    void setIcon( int index, const CFxUIIcon& icon );
 
    const CFxUIString& item( int index );
 
    void setItemText( int index, const CFxUIString& sText );
 
    void removeItem( int index );
 
    bool isItemSelected( int index );
 
    CFxUIVariant itemData( int index, int role = Qt::UserRole ) const;
 
    CFxUISignal<void(int)>& valueChanged();
 
    CFxUISignal<void( void )>& selectionChanged();
 
    CFxUISignal<void( const int& )>& itemDoubleClicked();
 
    //...
};