dropdown_type.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef DROPDOWN_TYPE_H
#define DROPDOWN_TYPE_H
 
#include "core/enum_type.hpp"
#include "stringfilter_type.h"
#include "window_type.h"
#include "gfx_func.h"
#include "gfx_type.h"
#include "palette_func.h"
#include "window_gui.h"

class DropDownListItem {
public:
  int result; 
  bool masked; 
  bool shaded; 
 
  explicit DropDownListItem(int result, bool masked = false, bool shaded = false) : result(result), masked(masked), shaded(shaded) {}
  virtual ~DropDownListItem() = default;

  virtual void FilterText([[maybe_unused]] StringFilter &string_filter) const {}

  virtual bool Selectable() const { return true; }

  virtual uint Height() const { return 0; }

  virtual uint Width() const { return 0; }

  virtual int OnClick([[maybe_unused]] const Rect &r, [[maybe_unused]] const Point &pt) const
  {
    return -1;
  }

  virtual void Draw(const Rect &full, [[maybe_unused]] const Rect &r, [[maybe_unused]] bool sel, [[maybe_unused]] int click_result, Colours bg_colour) const
  {
    if (this->masked) GfxFillRect(full, GetColourGradient(bg_colour, SHADE_LIGHT), FILLRECT_CHECKER);
  }

  TextColour GetColour(bool sel) const
  {
    if (this->shaded) return (sel ? TC_SILVER : TC_GREY) | TC_NO_SHADE;
    return sel ? TC_WHITE : TC_BLACK;
  }
};

typedef std::vector<std::unique_ptr<const DropDownListItem>> DropDownList;

enum class DropDownOption : uint8_t {
  InstantClose, 
  Persist, 
  Filterable, 
};
using DropDownOptions = EnumBitSet<DropDownOption, uint8_t>;
 
void ShowDropDownListAt(Window *w, DropDownList &&list, int selected, WidgetID button, Rect wi_rect, Colours wi_colour, DropDownOptions options = {}, std::string * const persistent_filter_text = nullptr);
 
void ShowDropDownList(Window *w, DropDownList &&list, int selected, WidgetID button, uint width = 0, DropDownOptions options = {}, std::string * const persistent_filter_text = nullptr);
 
Dimension GetDropDownListDimension(const DropDownList &list);
 
void ReplaceDropDownList(Window *parent, DropDownList &&list, std::optional<int> selected_result = std::nullopt);
 
#endif /* DROPDOWN_TYPE_H */