Public Types
enum	MsgType { MSG_NONE , MSG_INFO , MSG_WARN , MSG_ERROR , MSG_DISCARD }

Public Member Functions
	SdlConnectionDialogWrapper (wLog *log)

	SdlConnectionDialogWrapper (const SdlConnectionDialogWrapper &other)=delete

	SdlConnectionDialogWrapper (SdlConnectionDialogWrapper &&other)=delete

SdlConnectionDialogWrapper &	operator= (const SdlConnectionDialogWrapper &other)=delete

SdlConnectionDialogWrapper &	operator= (SdlConnectionDialogWrapper &&other)=delete

void	create (rdpContext *context)

void	destroy ()

bool	isRunning () const

bool	isVisible () const

bool	handleEvent (const SDL_Event &event)

void	setTitle (WINPR_FORMAT_ARG const char *fmt,...)

void	setTitle (const std::string &title)

void	showInfo (WINPR_FORMAT_ARG const char *fmt,...)

void	showInfo (const std::string &info)

void	showWarn (WINPR_FORMAT_ARG const char *fmt,...)

void	showWarn (const std::string &info)

void	showError (WINPR_FORMAT_ARG const char *fmt,...)

void	showError (const std::string &error)

void	show (SdlConnectionDialogWrapper::MsgType type, const std::string &msg)

void	show (bool visible=true)

void	handleShow ()

Detailed Description

Definition at line 36 of file sdl_connection_dialog_wrapper.hpp.

Member Enumeration Documentation

◆ MsgType

enum SdlConnectionDialogWrapper::MsgType

Definition at line 39 of file sdl_connection_dialog_wrapper.hpp.

  {
    MSG_NONE,
    MSG_INFO,
    MSG_WARN,
    MSG_ERROR,
    MSG_DISCARD
  };

Constructor & Destructor Documentation

◆ SdlConnectionDialogWrapper()

SdlConnectionDialogWrapper::SdlConnectionDialogWrapper ( wLog * log )

explicit

FreeRDP: A Remote Desktop Protocol Implementation SDL Client helper dialogs

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Definition at line 31 of file sdl_connection_dialog_wrapper.cpp.

                                                                : _log(log)
{
}

Member Function Documentation

◆ create()

void SdlConnectionDialogWrapper::create ( rdpContext * context )

Definition at line 37 of file sdl_connection_dialog_wrapper.cpp.

{
  const auto enabled =
      freerdp_settings_get_bool(context->settings, FreeRDP_UseCommonStdioCallbacks);
  _connection_dialog.reset();
  if (!enabled)
    _connection_dialog = std::make_unique<SDLConnectionDialog>(context);
}

◆ destroy()

void SdlConnectionDialogWrapper::destroy ( )

Definition at line 46 of file sdl_connection_dialog_wrapper.cpp.

{
  _connection_dialog.reset();
}

◆ handleEvent()

bool SdlConnectionDialogWrapper::handleEvent ( const SDL_Event & event )

Definition at line 72 of file sdl_connection_dialog_wrapper.cpp.

{
  std::unique_lock lock(_mux);
  if (!_connection_dialog)
    return false;
  return _connection_dialog->handle(event);
}

◆ handleShow()

void SdlConnectionDialogWrapper::handleShow ( )

Definition at line 164 of file sdl_connection_dialog_wrapper.cpp.

{
  std::unique_lock lock(_mux);
  while (!_queue.empty())
  {
    auto arg = _queue.front();
    _queue.pop();
 
    if (arg.hasTitle() && _connection_dialog)
    {
      std::ignore = _connection_dialog->setTitle(arg.title().c_str());
    }
 
    if (arg.hasType() && arg.hasMessage())
    {
      switch (arg.type())
      {
        case SdlConnectionDialogWrapper::MSG_INFO:
          if (_connection_dialog)
            std::ignore = _connection_dialog->showInfo(arg.message().c_str());
          else
            WLog_Print(_log, WLOG_INFO, "%s", arg.message().c_str());
          break;
        case SdlConnectionDialogWrapper::MSG_WARN:
          if (_connection_dialog)
            std::ignore = _connection_dialog->showWarn(arg.message().c_str());
          else
            WLog_Print(_log, WLOG_WARN, "%s", arg.message().c_str());
          break;
        case SdlConnectionDialogWrapper::MSG_ERROR:
          if (_connection_dialog)
            std::ignore = _connection_dialog->showError(arg.message().c_str());
          else
            WLog_Print(_log, WLOG_ERROR, "%s", arg.message().c_str());
          break;
        default:
          break;
      }
    }
 
    if (arg.hasVisibility() && _connection_dialog)
    {
      if (arg.visible())
        std::ignore = _connection_dialog->show();
      else
        std::ignore = _connection_dialog->hide();
    }
  }
}

◆ isRunning()

bool SdlConnectionDialogWrapper::isRunning ( ) const

Definition at line 51 of file sdl_connection_dialog_wrapper.cpp.

{
  std::unique_lock lock(_mux);
  /* Messages are queued here and handled on the main thread, so the dialog is still busy
   * while the queue is not empty. Without this the event loop can leave before an error
   * pushed by the RDP thread was ever shown. */
  if (!_queue.empty())
    return true;
  if (!_connection_dialog)
    return false;
  return _connection_dialog->running();
}

◆ isVisible()

bool SdlConnectionDialogWrapper::isVisible ( ) const

Definition at line 64 of file sdl_connection_dialog_wrapper.cpp.

{
  std::unique_lock lock(_mux);
  if (!_connection_dialog)
    return false;
  return _connection_dialog->visible();
}

◆ setTitle()

void SdlConnectionDialogWrapper::setTitle ( const std::string & title )

Definition at line 109 of file sdl_connection_dialog_wrapper.cpp.

{
  push(EventArg{ title });
}

◆ show() [1/2]

void SdlConnectionDialogWrapper::show ( bool visible = true )

Definition at line 159 of file sdl_connection_dialog_wrapper.cpp.

{
  push(EventArg{ visible });
}

◆ show() [2/2]

void SdlConnectionDialogWrapper::show	(	SdlConnectionDialogWrapper::MsgType	type,
		const std::string &	msg
	)

Definition at line 153 of file sdl_connection_dialog_wrapper.cpp.

{
  push({ type, msg, true });
}

◆ showError()

void SdlConnectionDialogWrapper::showError ( const std::string & error )

Definition at line 148 of file sdl_connection_dialog_wrapper.cpp.

{
  show(MSG_ERROR, error);
}

◆ showInfo()

void SdlConnectionDialogWrapper::showInfo ( const std::string & info )

Definition at line 122 of file sdl_connection_dialog_wrapper.cpp.

{
  show(MSG_INFO, info);
}

◆ showWarn()

void SdlConnectionDialogWrapper::showWarn ( const std::string & info )

Definition at line 135 of file sdl_connection_dialog_wrapper.cpp.

{
  show(MSG_WARN, info);
}

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

Public Types

Public Member Functions