querystring_gui.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 QUERYSTRING_GUI_H
#define QUERYSTRING_GUI_H
 
#include "textbuf_type.h"
#include "textbuf_gui.h"
#include "window_gui.h"

struct QueryString {
  /* Special actions when hitting ENTER or ESC. (only keyboard, not OSK) */
  static const int ACTION_NOTHING  = -1; 
  static const int ACTION_DESELECT = -2; 
  static const int ACTION_CLEAR    = -3; 
 
  StringID caption{};
  int ok_button = ACTION_NOTHING; 
  int cancel_button = ACTION_DESELECT; 
  Textbuf text;
  std::optional<std::string> orig{};
  bool handled = false;

  QueryString(uint16_t size, uint16_t chars = UINT16_MAX) : text(size, chars)
  {
  }
 
public:
  void DrawEditBox(const Window *w, WidgetID wid) const;
  void ClickEditBox(Window *w, Point pt, WidgetID wid, int click_count, bool focus_changed);
  void HandleEditBox(Window *w, WidgetID wid);
 
  Point GetCaretPosition(const Window *w, WidgetID wid) const;
  Rect GetBoundingRect(const Window *w, WidgetID wid, size_t from, size_t to) const;
  ptrdiff_t GetCharAtPosition(const Window *w, WidgetID wid, const Point &pt) const;
};
 
void ShowOnScreenKeyboard(Window *parent, WidgetID button);
void UpdateOSKOriginalText(const Window *parent, WidgetID button);
bool IsOSKOpenedFor(const Window *w, WidgetID button);
 
#endif /* QUERYSTRING_GUI_H */