text: /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  //
  // TGUI - Texus' Graphical User Interface
  // Copyright (C) 2012-2017 Bruno Van de Velde (vdv_b@tgui.eu)
  //
  // This software is provided 'as-is', without any express or implied warranty.
  // In no event will the authors be held liable for any damages arising from the use of this software.
  //
  // Permission is granted to anyone to use this software for any purpose,
  // including commercial applications, and to alter it and redistribute it freely,
  // subject to the following restrictions:
  //
  // 1. The origin of this software must not be misrepresented;
  //    you must not claim that you wrote the original software.
  //    If you use this software in a product, an acknowledgment
  //    in the product documentation would be appreciated but is not required.
  //
  // 2. Altered source versions must be plainly marked as such,
  //    and must not be misrepresented as being the original software.
  //
  // 3. This notice may not be removed or altered from any source distribution.
  //
  /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  
  
  #ifndef TGUI_LIST_BOX_RENDERER_HPP
  #define TGUI_LIST_BOX_RENDERER_HPP
  
  
  #include <TGUI/Renderers/WidgetRenderer.hpp>
  
  /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  
  namespace tgui
  {
      class TGUI_API ListBoxRenderer : public WidgetRenderer
      {
      public:
  
          using WidgetRenderer::WidgetRenderer;
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Changes the size of the borders
          ///
          /// @param borders  Size of the borders
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          void setBorders(const Borders& borders);
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Returns the size of the borders
          ///
          /// @return border size
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          Borders getBorders() const;
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Changes the padding of the list box
          ///
          /// @param padding  The padding width and height
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          void setPadding(const Padding& padding);
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Returns the size of the padding
          ///
          /// @return padding size
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          Padding getPadding() const;
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Changes the text style
          ///
          /// @param style  New text style
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          void setTextStyle(TextStyle style);
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Returns text style
          ///
          /// @return Style of the text
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          TextStyle getTextStyle() const;
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Changes the text style of the selected item
          ///
          /// @param style  New text style
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          void setSelectedTextStyle(TextStyle style);
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Returns text style of the selected item
          ///
          /// @return Style of the text
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          TextStyle getSelectedTextStyle() const;
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Changes the background color of the list box
          ///
          /// @param backgroundColor  The new background color
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          void setBackgroundColor(Color backgroundColor);
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Returns the background color
          ///
          /// @return Background color
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          Color getBackgroundColor() const;
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Changes the background color used for the item below the mouse
          ///
          /// @param backgroundColor  The new hover background color
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          void setBackgroundColorHover(Color backgroundColor);
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Returns the background color used for the item below the mouse
          ///
          /// @return Background color of hovered item
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          Color getBackgroundColorHover() const;
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Changes the background color of the selected item
          ///
          /// @param backgroundColor  The new selected item background color
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          void setSelectedBackgroundColor(Color backgroundColor);
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Returns the background color of the selected item
          ///
          /// @return Selected item background color
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          Color getSelectedBackgroundColor() const;
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Changes the background color used for the selected item when the mouse hovers over it
          ///
          /// @param backgroundColor  The new selected hover background color
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          void setSelectedBackgroundColorHover(Color backgroundColor);
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Returns the background color used for the selected item when the mouse hovers over it
          ///
          /// @return Background color of selected item in hover state
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          Color getSelectedBackgroundColorHover() const;
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Changes the color of the text
          ///
          /// @param textColor  The new text color
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          void setTextColor(Color textColor);
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Returns the color of the text
          ///
          /// @return Text color
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          Color getTextColor() const;
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Changes the color of the text of the item below the mouse
          ///
          /// @param textColor  The new hover text color
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          void setTextColorHover(Color textColor);
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Returns the color of the text of the item below the mouse
          ///
          /// @return Hover text color
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          Color getTextColorHover() const;
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Changes the color of the text from the selected item
          ///
          /// @param textColor  The new selected text color
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          void setSelectedTextColor(Color textColor);
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Returns the color of the text from the selected item
          ///
          /// @return Selected text color
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          Color getSelectedTextColor() const;
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Changes the color of the text of the selected item when it is below the mouse
          ///
          /// @param textColor  The new hover text color
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          void setSelectedTextColorHover(Color textColor);
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Returns the color of the text of the selected item when it is below the mouse
          ///
          /// @return Hover text color
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          Color getSelectedTextColorHover() const;
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Changes the color of the borders
          ///
          /// @param borderColor  The new border color
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          void setBorderColor(Color borderColor);
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Returns the color of the borders
          ///
          /// @return Border color
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          Color getBorderColor() const;
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Changes the background image of the list box
          ///
          /// @param texture  The background texture
          ///
          /// When this image is set, the background color property will be ignored.
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          void setTextureBackground(const Texture& texture);
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Returns the background image of the list box
          ///
          /// @return Background texture
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          Texture& getTextureBackground() const;
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Sets the renderer data of the scrollbar
          ///
          /// @param scrollbarRendererData  Data about how the scrollbar should look
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          void setScrollbar(std::shared_ptr<RendererData> scrollbarRendererData);
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          /// @brief Returns the renderer data of the scrollbar
          ///
          /// @return Data about how the scrollbar looks
          ///
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
          std::shared_ptr<RendererData> getScrollbar() const;
  
  
          /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
      };
  
      /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  }
  
  /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  
  #endif // TGUI_LIST_BOX_RENDERER_HPP
  