FxUIComboBox.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2025 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 "FxUIEnum.h"
#include "../Core/FxUIIcon.h"
#include "../Core/FxUIVariant.h"
 
#if defined( XENON )
namespace Wt
{
    class WValidator;
}
 
using CFxUIValidator = Wt::WValidator;
#else
class QValidator;
using CFxUIValidator = QValidator;
#endif

class COMMONUI_API CFxUIComboBox : public CFxUIBaseView
{
public:
    enum InsertPolicy
    {
        NoInsert, 
        InsertAtTop, 
        InsertAtCurrent, 
        InsertAtBottom, 
        InsertAfterCurrent, 
        InsertBeforeCurrent, 
        InsertAlphabetically 
 
    };

    CFxUIComboBox();

    ~CFxUIComboBox();

    void clear();

    void addItem( const CFxUIString & text, const CFxUIVariant & userData = CFxUIVariant() );
 

    void addItem( const CFxUIIcon & icon, const CFxUIString & text, const CFxUIVariant & userData = CFxUIVariant() );

    void insertItems( int index, const CFxUIStringList & list );

    void insertItem( int index, const CFxUIString & text, const CFxUIVariant & userData = CFxUIVariant() );

    void insertItem( int index, const CFxUIIcon & icon, const CFxUIString & text, const CFxUIVariant & userData = CFxUIVariant() );

    void removeItem( int index );


    void setItemText(int index, const CFxUIString & text);

    void setItemIcon( int index, const CFxUIIcon & icon );

    void setEditText(const CFxUIString & text);

    int count() const;

    void clearEditText();

 
    CFxUIVariant itemData( int index, int role = FxUIItemDataRole::UserRole ) const;

    void setItemData( int index, const CFxUIVariant& data, int role = FxUIItemDataRole::UserRole );

    CFxUIString itemText ( int index ) const;

    void setCurrentText( const CFxUIString& text );

    CFxUIString currentText() const;
 
    int findData( const CFxUIVariant& data,
                  int role = FxUIItemDataRole::UserRole,
                  FxUIMatchFlag flags = static_cast<FxUIMatchFlag>( FxUIMatchFlag ::MatchExactly |
                                                                    FxUIMatchFlag ::MatchCaseSensitive ) ) const;
    int findText( const CFxUIString& text,
                  FxUIMatchFlag flags = static_cast<FxUIMatchFlag>( FxUIMatchFlag ::MatchExactly |
                                                                    FxUIMatchFlag ::MatchCaseSensitive ) ) const;

    void setCurrentIndex( int iIndex );

    int currentIndex() const;
 
    void setHideEmptyText( bool );

    bool isEditable() const;

    void setEditable( bool );

    void setValidator( const CFxUIValidator* );

    void setInsertPolicy( CFxUIComboBox::InsertPolicy );

    void setIconSize( CFxUISize size );

    void setMaxVisibleItems( int Value );

    CFxUISignal<void(int)>&                activated();

    CFxUISignal<void(int)>&                currentIndexChanged();

    CFxUISignal<void(const CFxUIString&)>& currentStringChanged();

    CFxUISignal<void(const CFxUIString&)>& editTextChanged();

    CFxUISignal<void(void)>&               editingFinished();
 
    //...
};