Open 3D Engine AzQtComponents API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzQtComponents::FilteredSearchWidget Class Reference

Inherits QFrame.

Classes

struct  Config
 

Public Slots

virtual void ClearTypeFilter ()
 
virtual void SetFilterStateByIndex (int index, bool enabled)
 
void SetFilterState (int index, bool enabled)
 
void readSettings (QSettings &settings, const QString &widgetName)
 
void writeSettings (QSettings &settings, const QString &widgetName)
 

Signals

void TextFilterChanged (const QString &activeTextFilter)
 
void TypeFilterChanged (const SearchTypeFilterList &activeTypeFilters)
 
void placeholderTextChanged (const QString &placeholderText)
 
void textFilterFillsWidthChanged (bool fillsWidth)
 
void addFavoriteEntriesPressed ()
 
void addFavoriteSearchPressed ()
 

Public Member Functions

 FilteredSearchWidget (QWidget *parent=nullptr, bool willUseOwnSelector=false)
 
void SetUseFavorites (bool useFavorites)
 
void SetTypeFilterVisible (bool visible)
 
void SetTypeFilters (const SearchTypeFilterList &typeFilters)
 
void AddTypeFilter (const SearchTypeFilter &typeFilter)
 
void SetupOwnSelector (SearchTypeSelector *selector)
 
void AddTypeFilter (const QString &category, const QString &displayName, const QVariant &metadata={}, int globalFilterValue=-1, FilterCriteriaButton::ExtraButtonType type=FilterCriteriaButton::ExtraButtonType::None, const QString &extraIconFileName={})
 
void SetTextFilterVisible (bool visible)
 
void SetTextFilter (const QString &textFilter)
 
void ClearTextFilter ()
 
void AddFavoritesButtonPressed ()
 
bool IsAnyFilterActive ()
 
void AddWidgetToSearchWidget (QWidget *w)
 
void SetFilteredParentVisible (bool visible)
 
void setEnabledFiltersVisible (bool visible)
 
int GetTypeFilterCount ()
 
void GetTypeFilterDetails (const int index, QString &categoryKeyOut, QString &displayNameOut, bool &enabledOut)
 
void SetFilterState (const QString &category, const QString &displayName, bool enabled)
 
void SetFilterInputInterval (AZStd::chrono::milliseconds milliseconds)
 
QString placeholderText () const
 
void setPlaceholderText (const QString &placeholderText)
 
QString textFilter () const
 
bool hasStringFilter () const
 
bool textFilterFillsWidth () const
 
void setTextFilterFillsWidth (bool fillsWidth)
 
void clearLabelText ()
 
void setLabelText (const QString &newLabelText)
 
QString labelText () const
 
void SetFilteredParentViewState ()
 
QToolButton * assetTypeSelectorButton () const
 
void SetSelectionCount (int selectionCount)
 
void UseAlternativeButtonContainer (QFrame *container)
 ALlows the owning widget to replace the drop down button container with its own container.
 

Static Public Member Functions

static Config loadConfig (QSettings &settings)
 
static Config defaultConfig ()
 
static QString GetBackgroundColor ()
 
static QString GetSeparatorColor ()
 

Protected Member Functions

void emitTypeFilterChanged ()
 
QLineEdit * filterLineEdit () const
 
QToolButton * filterTypePushButton () const
 
SearchTypeSelectorfilterTypeSelector () const
 
const SearchTypeFilterList & typeFilters () const
 
virtual FilterCriteriaButtoncreateCriteriaButton (const SearchTypeFilter &filter, int filterIndex)
 
void CreateTextFilterButton ()
 
void createAddFavoriteSearchButton ()
 
void RepositionFixedButtons ()
 
virtual void SetupPaintDelegates ()
 

Protected Attributes

SearchTypeFilterList m_typeFilters
 
AZ_POP_DISABLE_WARNING FlowLayoutm_flowLayout
 
Ui::FilteredSearchWidget * m_ui
 
SearchTypeSelectorm_selector
 
QMap< int, FilterCriteriaButton * > m_typeButtons
 
AZ_POP_DISABLE_WARNING bool m_textFilterFillsWidth
 
bool m_displayEnabledFilters
 
FilterTextButtonm_filterTextButton = nullptr
 
SelectionCountButtonm_selectionCountButton = nullptr
 
QToolButton * m_addFavoritesButton = nullptr
 
QHBoxLayout * m_favoritesLayout = nullptr
 
QSpacerItem * m_endSpacer = nullptr
 

Properties

QString placeholderText
 
QString textFilter
 
bool textFilterFillsWidth
 

Friends

class Style
 

Member Function Documentation

◆ defaultConfig()

static Config AzQtComponents::FilteredSearchWidget::defaultConfig ( )
static

Returns default button config data.

◆ loadConfig()

static Config AzQtComponents::FilteredSearchWidget::loadConfig ( QSettings &  settings)
static

Loads the button config data from a settings object.


The documentation for this class was generated from the following file: