NDEVR
API Documentation
WebSocketConnectionDialogFactory

A ConnectionDialogFactory which allows for the creation of a WebSocketConnectionDialog. More...

Inheritance diagram for WebSocketConnectionDialogFactory:
[legend]
Collaboration diagram for WebSocketConnectionDialogFactory:
[legend]

Public Member Functions

virtual ConnectionDialogcreateConnectionDialog () const override
 Creates a new WebSocketConnectionDialog instance.
virtual bool handlesType (const StringView &connection) const override
 Checks whether this factory handles the given connection type string.
virtual StringView icon () const override
 Returns the icon name associated with WebSocket connections.
virtual TranslatedString title () const override
 Returns the user-facing title for this connection dialog type.
Public Member Functions inherited from ConnectionDialogFactory
virtual bool handlesConnection (const ConnectionInfo &connection) const
 Checks whether this factory can produce a dialog for the given connection.

Additional Inherited Members

Static Public Member Functions inherited from ConnectionDialogFactory
static Buffer< ConnectionDialogFactory * > ConnectionDialogFactories ()
 Returns all registered ConnectionDialogFactory instances.
static void RegisterConnectionFactory (ConnectionDialogFactory *factory)
 Registers a connection dialog factory for use by the application.
Static Protected Attributes inherited from ConnectionDialogFactory
static Buffer< ConnectionDialogFactory * > s_registered_factories
 All registered connection dialog factories.

Detailed Description

A ConnectionDialogFactory which allows for the creation of a WebSocketConnectionDialog.


Definition at line 138 of file WebSocketConnectionDialog.h.

Member Function Documentation

◆ createConnectionDialog()

virtual ConnectionDialog * WebSocketConnectionDialogFactory::createConnectionDialog ( ) const
overridevirtual

Creates a new WebSocketConnectionDialog instance.

Returns
A pointer to the newly created ConnectionDialog.

Implements ConnectionDialogFactory.

◆ handlesType()

virtual bool WebSocketConnectionDialogFactory::handlesType ( const StringView & connection) const
overridevirtual

Checks whether this factory handles the given connection type string.

Parameters
[in]connectionThe connection type identifier to test.
Returns
True if this factory can create a dialog for the specified type.

Implements ConnectionDialogFactory.

◆ icon()

virtual StringView WebSocketConnectionDialogFactory::icon ( ) const
overridevirtual

Returns the icon name associated with WebSocket connections.

Returns
A string view identifying the icon resource.

Implements ConnectionDialogFactory.

◆ title()

virtual TranslatedString WebSocketConnectionDialogFactory::title ( ) const
overridevirtual

Returns the user-facing title for this connection dialog type.

Returns
A translated string suitable for display in menus or headers.

Implements ConnectionDialogFactory.


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