Public Slots | Signals | Public Member Functions | List of all members
gazebo::gui::RestUiLoginDialog Class Reference

Provides a means to login to a webservice. More...

#include <RestUiLoginDialog.hh>

Inheritance diagram for gazebo::gui::RestUiLoginDialog:
Inheritance graph
[legend]

Public Slots

void SlotAcceptLogin ()
 Slot for the AcceptLogin event. More...
 

Signals

void AcceptLogin (QString &_url, QString &_username, QString &_password)
 Emitted when the user presses the login button. More...
 

Public Member Functions

 RestUiLoginDialog (QWidget *_parent, const std::string &_title, const std::string &_urlLabel, const std::string &_defautlUrl)
 Constructor. More...
 
std::string GetPassword () const
 Getter for the password. More...
 
std::string GetUrl () const
 Getter for the Url. More...
 
std::string GetUsername () const
 Getter for User name (of the basic auth REST service) More...
 

Detailed Description

Provides a means to login to a webservice.

Constructor & Destructor Documentation

gazebo::gui::RestUiLoginDialog::RestUiLoginDialog ( QWidget *  _parent,
const std::string &  _title,
const std::string &  _urlLabel,
const std::string &  _defautlUrl 
)

Constructor.

Parameters
[in]_parentParent QWidget
[in]_titleThe dialog window title bar text
[in]_urlLabel the title of the url (ex: super webservice url)
[in]_defaultUrlUrl text for the url (ex: https://superweb.com)

Member Function Documentation

void gazebo::gui::RestUiLoginDialog::AcceptLogin ( QString &  _url,
QString &  _username,
QString &  _password 
)
signal

Emitted when the user presses the login button.

Parameters
[in]_urlThe web server url
[in]_usernameThe user name
[in]_passwordThe user password
std::string gazebo::gui::RestUiLoginDialog::GetPassword ( ) const

Getter for the password.

Returns
The password
std::string gazebo::gui::RestUiLoginDialog::GetUrl ( ) const

Getter for the Url.

Returns
The url for the site (ex: https://yoursite.com:4000)
std::string gazebo::gui::RestUiLoginDialog::GetUsername ( ) const

Getter for User name (of the basic auth REST service)

Returns
User name
void gazebo::gui::RestUiLoginDialog::SlotAcceptLogin ( )
slot

Slot for the AcceptLogin event.


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