From c04dcc2e7d834218ef2d4194331e383402495ae1 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 10 Apr 2024 20:07:22 +0200 Subject: Adding upstream version 2:20.4+dfsg. Signed-off-by: Daniel Baumann --- xbmc/interfaces/builtins/PictureBuiltins.cpp | 135 +++++++++++++++++++++++++++ 1 file changed, 135 insertions(+) create mode 100644 xbmc/interfaces/builtins/PictureBuiltins.cpp (limited to 'xbmc/interfaces/builtins/PictureBuiltins.cpp') diff --git a/xbmc/interfaces/builtins/PictureBuiltins.cpp b/xbmc/interfaces/builtins/PictureBuiltins.cpp new file mode 100644 index 0000000..15cfe0a --- /dev/null +++ b/xbmc/interfaces/builtins/PictureBuiltins.cpp @@ -0,0 +1,135 @@ +/* + * Copyright (C) 2005-2018 Team Kodi + * This file is part of Kodi - https://kodi.tv + * + * SPDX-License-Identifier: GPL-2.0-or-later + * See LICENSES/README.md for more information. + */ + +#include "PictureBuiltins.h" + +#include "GUIUserMessages.h" +#include "ServiceBroker.h" +#include "guilib/GUIComponent.h" +#include "guilib/GUIWindowManager.h" +#include "utils/StringUtils.h" + +/*! \brief Show a picture. + * \param params The parameters. + * \details params[0] = URL of picture. + */ +static int Show(const std::vector& params) +{ + CGUIMessage msg(GUI_MSG_SHOW_PICTURE, 0, 0); + msg.SetStringParam(params[0]); + CGUIWindow *pWindow = CServiceBroker::GetGUI()->GetWindowManager().GetWindow(WINDOW_SLIDESHOW); + if (pWindow) + pWindow->OnMessage(msg); + + return 0; +} + +/*! \brief Start a slideshow. + * \param params The parameters. + * \details params[0] = Path to run slideshow for. + * params[1,..] = "recursive" to run a recursive slideshow. + * params[1,...] = "random" to randomize slideshow. + * params[1,...] = "notrandom" to not randomize slideshow. + * params[1,...] = "pause" to start slideshow paused. + * params[1,...] = "beginslide=" to start at a given slide. + * + * Set the template parameter Recursive to true to run a recursive slideshow. + */ + template +static int Slideshow(const std::vector& params) +{ + std::string beginSlidePath; + // leave RecursiveSlideShow command as-is + unsigned int flags = 0; + if (Recursive) + flags |= 1; + + // SlideShow(dir[,recursive][,[not]random][,pause][,beginslide="/path/to/start/slide.jpg"]) + // the beginslide value need be escaped (for '"' or '\' in it, by backslash) + // and then quoted, or not. See CUtil::SplitParams() + else + { + for (unsigned int i = 1 ; i < params.size() ; i++) + { + if (StringUtils::EqualsNoCase(params[i], "recursive")) + flags |= 1; + else if (StringUtils::EqualsNoCase(params[i], "random")) // set fullscreen or windowed + flags |= 2; + else if (StringUtils::EqualsNoCase(params[i], "notrandom")) + flags |= 4; + else if (StringUtils::EqualsNoCase(params[i], "pause")) + flags |= 8; + else if (StringUtils::StartsWithNoCase(params[i], "beginslide=")) + beginSlidePath = params[i].substr(11); + } + } + + CGUIMessage msg(GUI_MSG_START_SLIDESHOW, 0, 0, flags); + std::vector strParams; + strParams.push_back(params[0]); + strParams.push_back(beginSlidePath); + msg.SetStringParams(strParams); + CGUIWindow *pWindow = CServiceBroker::GetGUI()->GetWindowManager().GetWindow(WINDOW_SLIDESHOW); + if (pWindow) + pWindow->OnMessage(msg); + + return 0; +} + +// Note: For new Texts with comma add a "\" before!!! Is used for table text +// +/// \page page_List_of_built_in_functions +/// \section built_in_functions_11 Picture built-in's +/// +/// ----------------------------------------------------------------------------- +/// +/// \table_start +/// \table_h2_l{ +/// Function, +/// Description } +/// \table_row2_l{ +/// `RecursiveSlideShow(dir)` +/// , +/// Run a slideshow from the specified directory\, including all subdirs. +/// @param[in] dir Path to run slideshow for. +/// @param[in] random Add "random" to randomize slideshow (optional). +/// @param[in] notrandom Add "notrandom" to not randomize slideshow (optional). +/// @param[in] pause Add "pause" to start slideshow paused (optional). +/// @param[in] beginslide Add "beginslide=" to start at a given slide (optional). +/// } +/// \table_row2_l{ +/// `ShowPicture(picture)` +/// , +/// Display a picture by file path. +/// @param[in] url URL of picture. +/// } +/// \table_row2_l{ +/// `SlideShow(dir [\,recursive\, [not]random])` +/// , +/// Starts a slideshow of pictures in the folder dir. Optional parameters are +/// recursive\, and **random** or **notrandom** slideshow\, adding images +/// from sub-folders. The **random** and **notrandom** parameters override +/// the Randomize setting found in the pictures media window. +/// @param[in] dir Path to run slideshow for. +/// @param[in] recursive Add "recursive" to run a recursive slideshow (optional). +/// @param[in] random Add "random" to randomize slideshow (optional). +/// @param[in] notrandom Add "notrandom" to not randomize slideshow (optional). +/// @param[in] pause Add "pause" to start slideshow paused (optional). +/// @param[in] beginslide Add "beginslide=" to start at a given slide (optional). +/// } +/// \table_end +/// + +CBuiltins::CommandMap CPictureBuiltins::GetOperations() const +{ + return { + {"recursiveslideshow", {"Run a slideshow from the specified directory, including all subdirs", 1, Slideshow}}, + {"showpicture", {"Display a picture by file path", 1, Show}}, + {"slideshow", {"Run a slideshow from the specified directory", 1, Slideshow}} + }; +} -- cgit v1.2.3