Provide a dialog to quickly find an entry in a list. More...

#include <mythdialogbox.h>

Inheritance diagram for MythUISearchDialog:

[legend]

Collaboration diagram for MythUISearchDialog:

[legend]

Signals
void	haveResult (QString)

Signals inherited from MythScreenType
void	Exiting ()

Signals inherited from MythUIType
void	RequestUpdate ()

void	RequestRegionUpdate (const QRect &)

void	TakingFocus ()

void	LosingFocus ()

void	VisibilityChanged (bool Visible)

void	Showing ()

void	Hiding ()

void	Enabling ()

void	Disabling ()

void	FinishedMoving ()

void	FinishedFading ()

void	DependChanged (bool isDefault)

Public Member Functions
	MythUISearchDialog (MythScreenStack *parent, QString title, QStringList list, bool matchAnywhere=false, QString defaultValue="")
	the classes constructor More...

bool	Create (void) override

void	SetReturnEvent (QObject *retobject, const QString &resultid)

Public Member Functions inherited from MythScreenType
	MythScreenType (MythScreenStack *parent, const QString &name, bool fullscreen=true)

	~MythScreenType () override

bool	keyPressEvent (QKeyEvent *event) override
	Key event handler. More...

bool	inputMethodEvent (QInputMethodEvent *event) override
	Input Method event handler. More...

bool	gestureEvent (MythGestureEvent *event) override
	Mouse click/movement handler, receives mouse gesture events from the QCoreApplication event loop. More...

virtual void	ShowMenu (void)

void	doInit (void)

void	LoadInForeground (void)

bool	IsInitialized (void) const
	Has Init() been called on this screen? More...

bool	IsFullscreen (void) const

void	SetFullscreen (bool full)

MythUIType *	GetFocusWidget (void) const

bool	SetFocusWidget (MythUIType *widget=nullptr)

virtual bool	NextPrevWidgetFocus (bool up_or_down)

void	BuildFocusList (void)

MythScreenStack *	GetScreenStack () const

virtual void	aboutToHide (void)

virtual void	aboutToShow (void)

bool	IsDeleting (void) const

void	SetDeleting (bool deleting)

bool	IsLoading (void) const

bool	IsLoaded (void) const

MythPainter *	GetPainter (void) override

Public Member Functions inherited from MythUIComposite
	MythUIComposite (QObject *parent, const QString &name)

	~MythUIComposite () override=default

virtual void	SetTextFromMap (const InfoMap &infoMap)

virtual void	ResetMap (const InfoMap &infoMap)

Public Member Functions inherited from MythUIType
	MythUIType (QObject *parent, const QString &name)

virtual void	Reset (void)
	Reset the widget to it's original state, should not reset changes made by the theme. More...

void	AddChild (MythUIType *child)
	Add a child UIType. More...

MythUIType *	GetChild (const QString &name) const
	Get a named child of this UIType. More...

MythUIType *	GetChildAt (QPoint p, bool recursive=true, bool focusable=true) const
	Return the first MythUIType at the given coordinates. More...

QList< MythUIType * > *	GetAllChildren (void)
	Return a list of all child widgets. More...

QList< MythUIType * >	GetAllDescendants (void)

void	DeleteChild (const QString &name)
	Delete a named child of this UIType. More...

void	DeleteChild (MythUIType *child)
	Delete the given UIType if it is a child of this UIType. More...

void	DeleteAllChildren (void)
	Delete all child widgets. More...

bool	NeedsRedraw (void) const

void	ResetNeedsRedraw (void)

void	SetRedraw (void)

void	SetChildNeedsRedraw (MythUIType *child)

bool	CanTakeFocus (void) const
	Return if this widget can accept input focus. More...

void	SetCanTakeFocus (bool set=true)
	Set whether this widget can take focus. More...

void	SetFocusOrder (int order)

bool	IsEnabled (void) const

void	SetEnabled (bool enable)

bool	MoveToTop (void)

bool	MoveChildToTop (MythUIType *child)

void	ActivateAnimations (MythUIAnimation::Trigger trigger)

QList< MythUIAnimation * > *	GetAnimations (void)

virtual void	Pulse (void)
	Pulse is called 70 times a second to trigger a single frame of an animation. More...

void	Draw (MythPainter *p, int xoffset, int yoffset, int alphaMod=255, QRect clipRect=QRect())

void	SetPosition (int x, int y)
	Convenience method, calls SetPosition(const MythPoint&) Override that instead to change functionality. More...

void	SetPosition (QPoint point)

virtual void	SetPosition (const MythPoint &point)

virtual MythPoint	GetPosition (void) const

virtual void	SetSize (QSize size)

virtual void	SetMinSize (const MythPoint &size)
	Set the minimum size of this widget, for widgets which can be rescaled. More...

virtual QSize	GetMinSize (void) const

virtual void	SetArea (const MythRect &rect)

virtual void	AdjustMinArea (int delta_x, int delta_y, int delta_w, int delta_h)
	Adjust the size of a sibling. More...

virtual void	VanishSibling (void)

virtual void	SetMinAreaParent (MythRect actual_area, MythRect allowed_area, MythUIType *child)
	Adjust the size of sibling objects within the button. More...

virtual void	SetMinArea (const MythRect &rect)
	Set the minimum area based on the given size. More...

virtual MythRect	GetArea (void) const
	If the object has a minimum area defined, return it, other wise return the default area. More...

virtual MythRect	GetFullArea (void) const

virtual void	RecalculateArea (bool recurse=true)

void	ExpandArea (QRect rect)

virtual QRegion	GetDirtyArea (void) const

bool	IsVisible (bool recurse=false) const

virtual void	SetVisible (bool visible)

void	MoveTo (QPoint destXY, QPoint speedXY)

void	AdjustAlpha (int mode, int alphachange, int minalpha=0, int maxalpha=255)

void	SetAlpha (int newalpha)

int	GetAlpha (void) const

virtual void	mediaEvent (MythMediaEvent *event)
	Media/Device status event handler, received from MythMediaMonitor. More...

MythFontProperties *	GetFont (const QString &text) const

bool	AddFont (const QString &text, MythFontProperties *fontProp)

void	SetHelpText (const QString &text)

QString	GetHelpText (void) const

void	SetXMLLocation (const QString &filename, int where)

QString	GetXMLLocation (void) const

void	SetXMLName (const QString &name)

QString	GetXMLName (void) const

bool	IsDeferredLoading (bool recurse=false) const

void	SetDeferLoad (bool defer)

virtual void	LoadNow (void)
	Cause images in this and child widgets to be loaded. More...

bool	ContainsPoint (QPoint point) const
	Check if the given point falls within this widgets area. More...

void	SetPainter (MythPainter *painter)

void	SetCentre (UIEffects::Centre centre)

void	SetZoom (float zoom)

void	SetHorizontalZoom (float zoom)

void	SetVerticalZoom (float zoom)

void	SetAngle (float angle)

void	SetDependIsDefault (bool isDefault)

void	SetReverseDependence (MythUIType *dependee, bool reverse)

void	SetDependsMap (QMap< QString, QString > dependsMap)

QMap< QString, QString >	GetDependsMap () const

Private Slots
void	slotSendResult (void)

void	slotUpdateList (void)

Private Attributes
MythUIButtonList *	m_itemList { nullptr }

MythUITextEdit *	m_textEdit { nullptr }

MythUIText *	m_titleText { nullptr }

MythUIText *	m_matchesText { nullptr }

QString	m_title

QString	m_defaultValue

QStringList	m_list

bool	m_matchAnywhere { false }

QObject *	m_retObject { nullptr }

QString	m_id

Additional Inherited Members
Public Slots inherited from MythScreenType
virtual void	Close ()

Public Slots inherited from MythUIType
void	LoseFocus ()

bool	TakeFocus ()

void	Activate ()

void	Hide (void)

void	Show (void)

void	Refresh (void)

void	UpdateDependState (bool isDefault)

void	UpdateDependState (MythUIType *dependee, bool isDefault)

Static Public Member Functions inherited from XMLParseBase
static QString	getFirstText (QDomElement &element)

static bool	parseBool (const QString &text)

static bool	parseBool (QDomElement &element)

static MythPoint	parsePoint (const QString &text, bool normalize=true)

static MythPoint	parsePoint (QDomElement &element, bool normalize=true)

static QSize	parseSize (const QString &text, bool normalize=true)

static QSize	parseSize (QDomElement &element, bool normalize=true)

static MythRect	parseRect (const QString &text, bool normalize=true)

static MythRect	parseRect (QDomElement &element, bool normalize=true)

static int	parseAlignment (const QString &text)

static int	parseAlignment (QDomElement &element)

static QBrush	parseGradient (const QDomElement &element)

static QString	parseText (QDomElement &element)

static MythUIType *	GetGlobalObjectStore (void)

static void	ClearGlobalObjectStore (void)

static void	ParseChildren (const QString &filename, QDomElement &element, MythUIType *parent, bool showWarnings)

static MythUIType *	ParseUIType (const QString &filename, QDomElement &element, const QString &type, MythUIType parent, MythScreenType screen, bool showWarnings, QMap< QString, QString > &parentDependsMap)

static bool	WindowExists (const QString &xmlfile, const QString &windowname)

static bool	LoadWindowFromXML (const QString &xmlfile, const QString &windowname, MythUIType *parent)

static bool	LoadBaseTheme (void)

static bool	LoadBaseTheme (const QString &baseTheme)

static bool	CopyWindowFromBase (const QString &windowname, MythScreenType *win)

Protected Member Functions inherited from MythScreenType
	MythScreenType (MythUIType *parent, const QString &name, bool fullscreen=true)

void	CopyFrom (MythUIType *base) override
	Copy this widgets state from another. More...

void	CreateCopy (MythUIType *parent) override
	Copy the state of this widget to the one given, it must be of the same type. More...

bool	ParseElement (const QString &filename, QDomElement &element, bool showWarnings) override
	Parse the xml definition of this widget setting the state of the object accordingly. More...

virtual void	Load (void)
	Load data which will ultimately be displayed on-screen or used to determine what appears on-screen (See Warning) More...

virtual void	Init (void)
	Used after calling Load() to assign data to widgets and other UI initilisation which is prohibited in Load() More...

void	LoadInBackground (const QString &message="")

void	ReloadInBackground (void)

void	OpenBusyPopup (const QString &message="")

void	CloseBusyPopup (void)

void	SetBusyPopupMessage (const QString &message)

void	ResetBusyPopup (void)

Protected Member Functions inherited from MythUIType
	~MythUIType () override

void	customEvent (QEvent *event) override

virtual void	DrawSelf (MythPainter *p, int xoffset, int yoffset, int alphaMod, QRect clipRect)

void	AddFocusableChildrenToList (FocusInfoType &focusList)

void	HandleAlphaPulse ()
	Handle one frame of an alpha (transparency) change animation. More...

void	HandleMovementPulse ()
	Handle one frame of a movement animation. More...

int	CalcAlpha (int alphamod) const

void	ConnectDependants (bool recurse=false)

virtual void	Finalize (void)
	Perform any post-xml parsing initialisation tasks. More...

Static Protected Member Functions inherited from MythUIType
static int	NormX (int width)

static int	NormY (int height)

Protected Attributes inherited from MythScreenType
bool	m_fullScreen {false}

bool	m_isDeleting {false}

QSemaphore	m_loadLock {1}

volatile bool	m_isLoading {false}

volatile bool	m_isLoaded {false}

bool	m_isInitialized {false}

MythUIType *	m_currentFocusWidget {nullptr}

FocusInfoType	m_focusWidgetList

MythScreenStack *	m_screenStack {nullptr}

MythUIBusyDialog *	m_busyPopup {nullptr}

QRegion	m_savedMask

Protected Attributes inherited from MythUIType
QList< MythUIType * >	m_childrenList

QMap< QString, QString >	m_dependsMap

QList< QPair< MythUIType *, bool > >	m_dependsValue

QList< int >	m_dependOperator

bool	m_visible {true}

bool	m_hasFocus {false}

bool	m_canHaveFocus {false}

bool	m_enabled {true}

bool	m_enableInitiator {false}

bool	m_initiator {false}

bool	m_vanish {false}

bool	m_vanished {false}

bool	m_isDependDefault {false}

QMap< MythUIType *, bool >	m_reverseDepend

int	m_focusOrder {0}

MythRect	m_area {0,0,0,0}

MythRect	m_minArea {0,0,0,0}

MythPoint	m_minSize

QRegion	m_dirtyRegion {0,0,0,0}

bool	m_needsRedraw {false}

UIEffects	m_effects

int	m_alphaChangeMode {0}

int	m_alphaChange {0}

int	m_alphaMin {0}

int	m_alphaMax {255}

bool	m_moving {false}

QPoint	m_xyDestination {0,0}

QPoint	m_xySpeed {0,0}

FontMap *	m_fonts {nullptr}

MythUIType *	m_parent {nullptr}

MythPainter *	m_painter {nullptr}

QList< MythUIAnimation * >	m_animations

QString	m_helptext

QString	m_xmlName

QString	m_xmlLocation

bool	m_deferload {false}

QColor	m_borderColor {Qt::black}

Detailed Description

Provide a dialog to quickly find an entry in a list.

You pass a QStringList containing the list you want to search. As the user enters a text string in the edit the list of entries changes to show only the entries that match the input string. You have the option to search anywhere in the string or only the start.

When the user either clicks an entry in the list or presses the OK button the dialog will either send a DialogCompletionEvent or an haveResult(QString) signal will be generated. Both pass the selected string back to the caller.

Definition at line 399 of file mythdialogbox.h.

Constructor & Destructor Documentation

◆ MythUISearchDialog()

MythUISearchDialog::MythUISearchDialog	(	MythScreenStack *	parent,
		QString	title,
		QStringList	list,
		bool	matchAnywhere = `false`,
		QString	defaultValue = `""`
	)

inline

the classes constructor

Parameters

parent	the MythScreenStack this widget belongs to
title	the text to show as the title
list	the list of text strings to search
matchAnywhere	if true will match the input text anywhere in the string. if false will match only strings that start with the input text. Default is false.
defaultValue	The initial value for the input text. Default is ""

Definition at line 413 of file mythdialogbox.h.

Member Function Documentation

◆ Create()

bool MythUISearchDialog::Create ( void )

overridevirtual

Reimplemented from MythScreenType.

Definition at line 777 of file mythdialogbox.cpp.

Referenced by BookmarkEditor::slotFindCategory().

◆ SetReturnEvent()

void MythUISearchDialog::SetReturnEvent	(	QObject *	retobject,
		const QString &	resultid
	)

Definition at line 822 of file mythdialogbox.cpp.

◆ haveResult

void MythUISearchDialog::haveResult ( QString )

signal

Referenced by ImportMusicDialog::chooseBackend(), Ripper::chooseBackend(), EditMetadataDialog::searchAlbum(), Ripper::searchAlbum(), EditMetadataDialog::searchArtist(), Ripper::searchArtist(), EditMetadataDialog::searchCompilationArtist(), EditMetadataDialog::searchGenre(), Ripper::searchGenre(), GameUI::searchStart(), VideoDialog::searchStart(), ProgLister::ShowChooseViewMenu(), ImportNative::showList(), BookmarkEditor::slotFindCategory(), slotSendResult(), and CriteriaRowEditor::valueButtonClicked().

◆ slotSendResult

void MythUISearchDialog::slotSendResult ( void )

privateslot

Definition at line 829 of file mythdialogbox.cpp.

Referenced by Create().

◆ slotUpdateList

void MythUISearchDialog::slotUpdateList ( void )

privateslot

Definition at line 847 of file mythdialogbox.cpp.

Referenced by Create().

Member Data Documentation

◆ m_itemList

MythUIButtonList* MythUISearchDialog::m_itemList { nullptr }

private

Definition at line 432 of file mythdialogbox.h.

Referenced by Create(), slotSendResult(), and slotUpdateList().

◆ m_textEdit

MythUITextEdit* MythUISearchDialog::m_textEdit { nullptr }

private

Definition at line 433 of file mythdialogbox.h.

Referenced by Create(), and slotUpdateList().

◆ m_titleText

MythUIText* MythUISearchDialog::m_titleText { nullptr }

private

Definition at line 434 of file mythdialogbox.h.

Referenced by Create().

◆ m_matchesText

MythUIText* MythUISearchDialog::m_matchesText { nullptr }

private

Definition at line 435 of file mythdialogbox.h.

Referenced by Create(), and slotUpdateList().

◆ m_title

QString MythUISearchDialog::m_title

private

Definition at line 437 of file mythdialogbox.h.

Referenced by Create().

◆ m_defaultValue

QString MythUISearchDialog::m_defaultValue

private

Definition at line 438 of file mythdialogbox.h.

Referenced by Create().

◆ m_list

QStringList MythUISearchDialog::m_list

private

Definition at line 439 of file mythdialogbox.h.

Referenced by slotUpdateList().

◆ m_matchAnywhere

bool MythUISearchDialog::m_matchAnywhere { false }

private

Definition at line 440 of file mythdialogbox.h.

Referenced by slotUpdateList().

◆ m_retObject

QObject* MythUISearchDialog::m_retObject { nullptr }

private

Definition at line 442 of file mythdialogbox.h.

Referenced by SetReturnEvent(), and slotSendResult().

◆ m_id

QString MythUISearchDialog::m_id

private

Definition at line 443 of file mythdialogbox.h.

Referenced by SetReturnEvent(), and slotSendResult().

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

Signals

Public Member Functions

Private Slots

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MythUISearchDialog()

Member Function Documentation

◆ Create()

◆ SetReturnEvent()

◆ haveResult

◆ slotSendResult

◆ slotUpdateList

Member Data Documentation

◆ m_itemList

◆ m_textEdit

◆ m_titleText

◆ m_matchesText

◆ m_title

◆ m_defaultValue

◆ m_list

◆ m_matchAnywhere

◆ m_retObject

◆ m_id