WebSocketConnectionDialog.h

Go to the documentation of this file.

#pragma once
/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
Licensee a limited, non-exclusive, non-transferable, royalty-free license
(without the right to sublicense) to use the API solely for the purpose of
Licensee's internal development efforts to develop applications for which
the API was provided.
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: NDEVR
File: SerialConnectionDialog
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include "HardwareWidgets/Headers/ConnectionDialog.h"
#include "DLLInfo.h"
#include <NDEVR/Connection.h>
#include "Base/Headers/Dictionary.h"
#include <QWidget>
namespace Ui
{
    class WebNetworkConnectionUI;
}
namespace NDEVR
{
    class Connection;
    class ProgressInfo;
    class Thread;
    /**--------------------------------------------------------------------------------------------------
    \brief A ConnectionDialog that allows the user to modify a WebSocketConnection
    **/
    class NDEVR_WEB_SOCKET_API WebSocketConnectionDialog : public ConnectionDialog
    {
        Q_OBJECT
    public:
        explicit WebSocketConnectionDialog(QWidget* parent = nullptr);
        ~WebSocketConnectionDialog();
        void setFixedProtocol(const String& mode);
        void clearFixedProtocol();
        virtual void clear() override;
        virtual ConnectionInfo connectionInfo() const override;
        virtual void setConnectionInfo(const ConnectionInfo& connection) override;
        virtual bool handlesConnection(const ConnectionInfo& connection) override;
        void setAllowPingLogic(bool allow_ping);
        void setAllowLocalButton(bool allow_local);
        bool checkIfValid() const;
        String protocol() const;
    protected slots:
        void updateFromDialog();
    protected:
        void refreshPingVisible();
    protected:
        String m_fixed_protocol;
        Ui::WebNetworkConnectionUI* ui;
        bool m_allow_ping_logic = true;
        bool m_allow_local_button = true;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief A ConnectionDialogFactory which allows for the creation of a WebSocketConnectionDialog
    **/
    class NDEVR_WEB_SOCKET_API WebSocketConnectionDialogFactory : public ConnectionDialogFactory
    {
    public:
        virtual bool handlesType(const String& connection) const override;
        virtual TranslatedString title() const override;
        virtual String icon() const override;
        virtual ConnectionDialog* createConnectionDialog() const override;
    };
}