#include <desktop.h>

Inheritance diagram for Desktop:

Public Member Functions
	Desktop (const Widget2 *const widget)

	~Desktop ()

void	reloadWallpaper ()

void	widgetResized (const Event &event)

void	draw (Graphics *const graphics)

void	safeDraw (Graphics *const graphics)

void	postInit ()

void	handleLink (const std::string &link, MouseEvent *event)

Public Member Functions inherited from Container
	Container (const Widget2 *const widget)

	~Container ()

bool	safeRemove (Widget *const widget)

void	removeControls ()

Public Member Functions inherited from BasicContainer2
	BasicContainer2 (const Widget2 *const widget)

	~BasicContainer2 ()

void	setOpaque (Opaque opaque)

bool	isOpaque () const

virtual void	add (Widget *const widget)

void	addXY (Widget *const widget, const int x, const int y)

Public Member Functions inherited from BasicContainer
	BasicContainer (const Widget2 *const widget)

	~BasicContainer ()

void	showWidgetPart (Widget *const widget, const Rect &area)

void	moveToTop (Widget *const widget)

void	moveToBottom (Widget *const widget)

Rect	getChildrenArea ()

void	focusNext ()

void	focusPrevious ()

void	logic ()

void	setFocusHandler (FocusHandler *const focusHandler)

void	setInternalFocusHandler (FocusHandler *const focusHandler)

Widget *	getWidgetAt (int x, int y)

void	death (const Event &event)

Widget *	findFirstWidget (const std::set< Widget * > &list)

void	add (Widget *const widget)

virtual void	remove (Widget *const widget)

virtual void	clear ()

Public Member Functions inherited from Widget
	Widget (const Widget2 *const widget)

	~Widget ()

virtual void	drawFrame (Graphics *graphics)

virtual void	safeDrawFrame (Graphics *graphics)

void	setFrameSize (const unsigned int frameSize)

unsigned int	getFrameSize () const

Widget *	getParent () const

void	setWidth (const int width)

int	getWidth () const

void	setHeight (const int height)

int	getHeight () const

void	setSize (const int width, const int height)

void	setX (const int x)

int	getX () const

void	setY (const int y)

int	getY () const

void	setPosition (const int x, const int y)

void	setDimension (const Rect &dimension)

const Rect &	getDimension () const

void	setFocusable (const bool focusable)

bool	isFocusable () const

virtual bool	isFocused () const

void	setEnabled (const bool enabled)

bool	isEnabled () const

void	setVisible (Visible visible)

bool	isVisible () const

void	setBaseColor (const Color &color)

const Color &	getBaseColor () const

void	setForegroundColor (const Color &color)

const Color &	getForegroundColor () const

void	setBackgroundColor (const Color &color)

const Color &	getBackgroundColor () const

virtual void	requestFocus ()

virtual void	requestMoveToTop ()

virtual void	requestMoveToBottom ()

FocusHandler *	getFocusHandler ()

void	addActionListener (ActionListener *const actionListener)

void	removeActionListener (ActionListener *const actionListener)

void	addDeathListener (WidgetDeathListener *const deathListener)

void	removeDeathListener (WidgetDeathListener *const deathListener)

void	addMouseListener (MouseListener *const mouseListener)

void	removeMouseListener (MouseListener *const mouseListener)

void	addKeyListener (KeyListener *const keyListener)

void	removeKeyListener (KeyListener *const keyListener)

void	addFocusListener (FocusListener *const focusListener)

void	removeFocusListener (FocusListener *const focusListener)

void	addWidgetListener (WidgetListener *const widgetListener)

void	removeWidgetListener (WidgetListener *const widgetListener)

void	setActionEventId (const std::string &actionEventId)

const std::string &	getActionEventId () const

virtual void	getAbsolutePosition (int &x, int &y) const

virtual void	setParent (Widget *parent)

Font *	getFont () const

void	setFont (Font *const font)

virtual void	fontChanged ()

bool	isTabInEnabled () const

void	setTabInEnabled (const bool enabled)

bool	isTabOutEnabled () const

void	setTabOutEnabled (const bool enabled)

void	requestModalFocus ()

virtual void	requestModalMouseInputFocus ()

virtual void	releaseModalFocus ()

virtual void	releaseModalMouseInputFocus ()

virtual bool	isModalFocused () const

virtual bool	isModalMouseInputFocused () const

const std::list< MouseListener * > &	getMouseListeners () const A_CONST

const std::list< KeyListener * > &	getKeyListeners () const A_CONST

const std::list< FocusListener * > &	getFocusListeners () const A_CONST

virtual FocusHandler *	getInternalFocusHandler ()

void	setInternalFocusHandler (FocusHandler *const internalFocusHandler)

void	setId (const std::string &id)

const std::string &	getId () const

virtual void	showPart (const Rect &rectangle)

bool	isAllowLogic () const

void	setMouseConsume (const bool b)

bool	isMouseConsume () const

void	setRedraw (const bool b)

virtual bool	isSelectable () const

void	setSelectable (const bool selectable)

void	windowResized ()

Public Member Functions inherited from Widget2
virtual	~Widget2 ()

const Color &	getThemeColor (const ThemeColorIdT type, const unsigned int alpha) const A_INLINE

const Color &	getThemeCharColor (const signed char c, bool &valid) const A_INLINE

virtual void	setWidget2 (const Widget2 *const widget)

void	setPalette (int palette)

void	checkPalette ()

void	setForegroundColor2 (const Color &color)

Widget *	getWindow () const

virtual void	setWindow (Widget *const window)

Public Member Functions inherited from WidgetDeathListener
virtual	~WidgetDeathListener ()

Public Member Functions inherited from LinkHandler
	LinkHandler ()

virtual	~LinkHandler ()

Public Member Functions inherited from WidgetListener
virtual	~WidgetListener ()

virtual void	widgetMoved (const Event &event)

virtual void	widgetHidden (const Event &event)

virtual void	widgetShown (const Event &event)

Private Member Functions
void	setBestFittingWallpaper ()

Private Attributes
Image *	mWallpaper

StaticBrowserBox *	mVersionLabel

Skin *	mSkin

Color	mBackgroundGrayColor

bool	mShowBackground

Additional Inherited Members
Static Public Member Functions inherited from Widget
static void	setGlobalFont (Font *const font)

static Font *	getGloablFont ()

static void	cleanGlobalFont ()

static bool	widgetExists (const Widget *const widget)

static void	distributeWindowResizeEvent ()

static Widget *	callPostInit (Widget *const widget)

Data Fields inherited from Widget
Visible	mVisible

Protected Types inherited from BasicContainer
typedef std::vector< Widget * >	WidgetList

typedef WidgetList::iterator	WidgetListIterator

typedef WidgetList::const_iterator	WidgetListConstIterator

typedef WidgetList::reverse_iterator	WidgetListReverseIterator

typedef WidgetList::const_reverse_iterator	WidgetListCReverseIterator

Protected Types inherited from Widget
typedef std::list< MouseListener * >	MouseListenerList

typedef MouseListenerList::iterator	MouseListenerIterator

typedef std::list< KeyListener * >	KeyListenerList

typedef KeyListenerList::iterator	KeyListenerIterator

typedef std::list< ActionListener * >	ActionListenerList

typedef ActionListenerList::iterator	ActionListenerIterator

typedef std::list< WidgetDeathListener * >	WidgetDeathListenerList

typedef WidgetDeathListenerList::iterator	WidgetDeathListenerIterator

typedef std::list< FocusListener * >	FocusListenerList

typedef FocusListenerList::iterator	FocusListenerIterator

typedef std::list< WidgetListener * >	WidgetListenerList

typedef WidgetListenerList::iterator	WidgetListenerIterator

Protected Member Functions inherited from BasicContainer
virtual void	drawChildren (Graphics *const graphics)

virtual void	safeDrawChildren (Graphics *const graphics)

virtual void	logicChildren ()

Protected Member Functions inherited from Widget
void	distributeActionEvent ()

void	distributeResizedEvent ()

void	distributeMovedEvent ()

void	distributeHiddenEvent ()

void	distributeShownEvent ()

Protected Member Functions inherited from Widget2
	Widget2 (const Widget2 *const widget)

Protected Member Functions inherited from WidgetDeathListener
	WidgetDeathListener ()

Protected Member Functions inherited from WidgetListener
	WidgetListener ()

Protected Attributes inherited from BasicContainer2
Opaque	mOpaque

Protected Attributes inherited from BasicContainer
WidgetList	mWidgets

WidgetList	mLogicWidgets

Protected Attributes inherited from Widget
MouseListenerList	mMouseListeners

KeyListenerList	mKeyListeners

ActionListenerList	mActionListeners

WidgetDeathListenerList	mDeathListeners

FocusListenerList	mFocusListeners

WidgetListenerList	mWidgetListeners

Color	mForegroundColor

Color	mBackgroundColor

Color	mBaseColor

Rect	mDimension

std::string	mActionEventId

std::string	mId

FocusHandler *	mFocusHandler

FocusHandler *	mInternalFocusHandler

Widget *	mParent

Font *	mCurrentFont

unsigned int	mFrameSize

bool	mFocusable

bool	mTabIn

bool	mTabOut

bool	mEnabled

bool	mAllowLogic

bool	mMouseConsume

bool	mRedraw

bool	mSelectable

Protected Attributes inherited from Widget2
int	mPaletteOffset

Widget *	mWindow

Color	mForegroundColor2

Static Protected Attributes inherited from Widget
static Font *	mGlobalFont = 0

Detailed Description

Desktop widget, for drawing a background image and color.

It picks the best fitting background image. If the image doesn't fit, a background color is drawn and the image is centered.

When the desktop widget is resized, the background image is automatically updated.

The desktop also displays the client version in the top-right corner.

Definition at line 51 of file desktop.h.

Constructor & Destructor Documentation

◆ Desktop()

Desktop::Desktop ( const Widget2 *const widget )

explicit

Definition at line 51 of file desktop.cpp.

                                             :
     Container(widget),
     LinkHandler(),
     WidgetListener(),
     mWallpaper(nullptr),
     mVersionLabel(new StaticBrowserBox(this, Opaque_false,
         "browserbox.xml")),
     mSkin(nullptr),
     mBackgroundGrayColor(getThemeColor(ThemeColorId::BACKGROUND_GRAY, 255U)),
     mShowBackground(true)
 {
     mBackgroundColor = getThemeColor(ThemeColorId::BACKGROUND, 128);
  
     addWidgetListener(this);
  
     Wallpaper::loadWallpapers();
  
     if (theme != nullptr)
     {
         mSkin = theme->load("desktop.xml",
             "",
             true,
             Theme::getThemePath());
     }
  
     if (mSkin != nullptr)
         mShowBackground = (mSkin->getOption("showBackground") != 0);
  
     const std::string appName = branding.getValue("appName", std::string());
     if (appName.empty())
     {
         mVersionLabel->addRow(FULL_VERSION,
             false);
     }
     else
     {
         mVersionLabel->addRow(strprintf("%s (%s)", FULL_VERSION,
             appName.c_str()),
             false);
     }
     mVersionLabel->addRow("copyright",
         "(C) ManaPlus developers, http://manaplus.org");
     mVersionLabel->setLinkHandler(this);
     mVersionLabel->updateHeight();
 }

References StaticBrowserBox::addRow(), Widget::addWidgetListener(), LinkHighlightMode::BACKGROUND, branding, FULL_VERSION, Skin::getOption(), Widget2::getThemeColor(), Theme::getThemePath(), ConfigurationObject::getValue(), Theme::load(), Wallpaper::loadWallpapers(), Widget::mBackgroundColor, mShowBackground, mSkin, mVersionLabel, StaticBrowserBox::setLinkHandler(), strprintf(), theme, and StaticBrowserBox::updateHeight().

◆ ~Desktop()

Desktop::~Desktop ( )

Definition at line 97 of file desktop.cpp.

 {
     if (mWallpaper != nullptr)
     {
         mWallpaper->decRef();
         mWallpaper = nullptr;
     }
     if (theme != nullptr)
         theme->unload(mSkin);
 }

References mSkin, mWallpaper, theme, and Theme::unload().

Member Function Documentation

◆ draw()

void Desktop::draw ( Graphics *const graphics )

virtual

Draws the widget. It is called by the parent widget when it is time for the widget to draw itself. The graphics object is set up so that all drawing is relative to the widget, i.e coordinate (0,0) is the top left corner of the widget. It is not possible to draw outside of a widget's dimension.

Parameters

graphics aA graphics object to draw with.

Reimplemented from BasicContainer2.

Definition at line 135 of file desktop.cpp.

 {
     BLOCK_START("Desktop::draw")
     GLDEBUG_START("Desktop::draw")
  
     const Rect &rect = mDimension;
     const int width = rect.width;
     const int height = rect.height;
     if (mWallpaper != nullptr)
     {
         const int wallpWidth = mWallpaper->getWidth();
         const int wallpHeight = mWallpaper->getHeight();
  
         if (width > wallpWidth || height > wallpHeight)
         {
             graphics->setColor(mBackgroundGrayColor);
             graphics->fillRectangle(Rect(0, 0, width, height));
         }
  
         if (imageHelper->useOpenGL() == RENDER_SOFTWARE)
         {
             graphics->drawImage(mWallpaper,
                 (width - wallpWidth) / 2,
                 (height - wallpHeight) / 2);
         }
         else
         {
             graphics->drawRescaledImage(mWallpaper, 0, 0, width, height);
         }
     }
     else
     {
         graphics->setColor(mBackgroundGrayColor);
         graphics->fillRectangle(Rect(0, 0, width, height));
     }
  
     Container::draw(graphics);
     GLDEBUG_END()
     BLOCK_END("Desktop::draw")
 }

References BLOCK_END, BLOCK_START, BasicContainer2::draw(), Graphics::drawImage(), Graphics::drawRescaledImage(), Graphics::fillRectangle(), GLDEBUG_END, GLDEBUG_START, Rect::height, imageHelper, mBackgroundGrayColor, Widget::mDimension, mWallpaper, RENDER_SOFTWARE, Graphics::setColor(), ImageHelper::useOpenGL(), and Rect::width.

Referenced by safeDraw().

◆ handleLink()

void Desktop::handleLink	(	const std::string &	link,
		MouseEvent *	event
	)

virtual

Implements LinkHandler.

Definition at line 233 of file desktop.cpp.

 {
     if (link == "copyright")
         inputManager.executeAction(InputAction::WINDOW_ABOUT);
 }

References InputManager::executeAction(), inputManager, and InputAction::WINDOW_ABOUT.

◆ postInit()

void Desktop::postInit ( )

virtual

Reimplemented from Widget.

Definition at line 108 of file desktop.cpp.

 {
     if (mSkin != nullptr)
     {
         addXY(mVersionLabel,
               mSkin->getOption("versionX", 25),
               mSkin->getOption("versionY", 2));
     }
     else
     {
         addXY(mVersionLabel, 25, 2);
     }
 }

References BasicContainer2::addXY(), Skin::getOption(), mSkin, and mVersionLabel.

◆ reloadWallpaper()

void Desktop::reloadWallpaper ( )

Has to be called after updates have been loaded.

Definition at line 122 of file desktop.cpp.

 {
     Wallpaper::loadWallpapers();
     setBestFittingWallpaper();
 }

References Wallpaper::loadWallpapers(), and setBestFittingWallpaper().

Referenced by ServerDialog::connectToSelectedServer(), Client::gameExec(), and Client::loadData().

◆ safeDraw()

void Desktop::safeDraw ( Graphics *const graphics )

virtual

Reimplemented from BasicContainer2.

Definition at line 176 of file desktop.cpp.

 {
     Desktop::draw(graphics);
 }

References draw().

◆ setBestFittingWallpaper()

void Desktop::setBestFittingWallpaper ( )

private

Definition at line 181 of file desktop.cpp.

 {
     if (!mShowBackground || !config.getBoolValue("showBackground"))
         return;
  
     const std::string wallpaperName =
         Wallpaper::getWallpaper(getWidth(), getHeight());
  
     Image *const nWallPaper = Theme::getImageFromTheme(wallpaperName);
  
     if (nWallPaper != nullptr)
     {
         if (mWallpaper != nullptr)
         {
             ResourceManager::decRefDelete(mWallpaper);
             mWallpaper = nullptr;
         }
  
         const Rect &rect = mDimension;
         const int width = rect.width;
         const int height = rect.height;
  
         if (imageHelper->useOpenGL() == RENDER_SOFTWARE &&
             (nWallPaper->getWidth() != width ||
             nWallPaper->getHeight() != height))
         {
             // We rescale to obtain a fullscreen wallpaper...
             Image *const newRsclWlPpr = Loader::getRescaled(
                 nWallPaper, width, height);
  
             if (newRsclWlPpr != nullptr)
             {
                 ResourceManager::decRefDelete(nWallPaper);
                 // We replace the resource in the resource manager
                 mWallpaper = newRsclWlPpr;
             }
             else
             {
                 mWallpaper = nWallPaper;
             }
         }
         else
         {
             mWallpaper = nWallPaper;
         }
     }
     else
     {
         logger->log("Couldn't load %s as wallpaper", wallpaperName.c_str());
     }
 }

References config, ResourceManager::decRefDelete(), Configuration::getBoolValue(), Widget::getHeight(), Theme::getImageFromTheme(), Loader::getRescaled(), Wallpaper::getWallpaper(), Widget::getWidth(), Rect::height, imageHelper, Logger::log(), logger, Widget::mDimension, mShowBackground, mWallpaper, RENDER_SOFTWARE, ImageHelper::useOpenGL(), and Rect::width.

Referenced by reloadWallpaper(), and widgetResized().

◆ widgetResized()

void Desktop::widgetResized ( const Event & event )

virtual

Invoked when a widget changes its size.

Parameters

event Describes the event.

Reimplemented from WidgetListener.

Definition at line 128 of file desktop.cpp.

 {
     mVersionLabel->setSize(getWidth(), getHeight());
     mVersionLabel->updateHeight();
     setBestFittingWallpaper();
 }

References Widget::getHeight(), Widget::getWidth(), mVersionLabel, setBestFittingWallpaper(), Widget::setSize(), and StaticBrowserBox::updateHeight().

Field Documentation

◆ mBackgroundGrayColor

Color Desktop::mBackgroundGrayColor

private

Definition at line 83 of file desktop.h.

Referenced by draw().

◆ mShowBackground

bool Desktop::mShowBackground

private

Definition at line 84 of file desktop.h.

Referenced by Desktop(), and setBestFittingWallpaper().

◆ mSkin

Skin* Desktop::mSkin

private

Definition at line 82 of file desktop.h.

Referenced by Desktop(), postInit(), and ~Desktop().

◆ mVersionLabel

StaticBrowserBox* Desktop::mVersionLabel

private

Definition at line 81 of file desktop.h.

Referenced by Desktop(), postInit(), and widgetResized().

◆ mWallpaper

Image* Desktop::mWallpaper

private

Definition at line 80 of file desktop.h.

Referenced by draw(), setBestFittingWallpaper(), and ~Desktop().

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

src/gui/widgets/desktop.h (986a3bf)
src/gui/widgets/desktop.cpp (986a3bf)

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Desktop()

◆ ~Desktop()

Member Function Documentation

◆ draw()

◆ handleLink()

◆ postInit()

◆ reloadWallpaper()

◆ safeDraw()

◆ setBestFittingWallpaper()

◆ widgetResized()

Field Documentation

◆ mBackgroundGrayColor

◆ mShowBackground

◆ mSkin

◆ mVersionLabel

◆ mWallpaper