inputbox.h

Go to the documentation of this file.

/*
  Created by Fabrizio Di Vittorio (fdivitto2013@gmail.com) - <http://www.fabgl.com>
  Copyright (c) 2019-2022 Fabrizio Di Vittorio.
  All rights reserved.
 
 
* Please contact fdivitto2013@gmail.com if you need a commercial license.
 
 
* This library and related software is available under GPL v3.
 
  FabGL 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, either version 3 of the License, or
  (at your option) any later version.
 
  FabGL 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 FabGL.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 
#pragma once
 
 
#include <stdint.h>
#include <stddef.h>
 
#include "fabglconf.h"
#include "fabui.h"
#include "fabutils.h"
#include "dispdrivers/vgapalettedcontroller.h"
#include "comdrivers/ps2controller.h"
 
 
 
namespace fabgl {
 
 
 
enum class InputResult {
  None        = 0,       
  ButtonExt0  = 1,       
  ButtonExt1  = 2,       
  ButtonExt2  = 3,       
  ButtonExt3  = 4,       
  Cancel      = 5,       
  ButtonLeft  = 5,       
  Enter       = 6,       
  ButtonRight = 6,       
};
 
 
 
// InputForm
 
 
class InputBox;
 
 
struct InputForm {
  InputForm(InputBox * inputBox_)
    : inputBox(inputBox_)
  {
  }
 
  void init(uiApp * app_, bool modalDialog_);
 
  virtual void addControls()      = 0;
  virtual void calcRequiredSize() = 0;
  virtual void finalize()         { }
  virtual void show()             { }
 
  void doExit(int value);
  void defaultEnterHandler(uiKeyEventInfo const & key);
  void defaultEscapeHandler(uiKeyEventInfo const & key);
 
 
  static constexpr int BUTTONS  = 6;
 
  InputBox *       inputBox;
 
  uiApp *          app;
 
  char const *     titleText;
  int              autoOK;
 
  FontInfo const * font;
  int              requiredWidth;
  int              requiredHeight;
 
  uiFrame *        mainFrame;
  uiPanel *        panel;
  uiLabel *        autoOKLabel;
 
  InputResult      retval;
  int              buttonSubItem;    // in case of button with subitems, specifies the selected subitem
 
  uiWindow *       controlToFocus;
 
  bool             modalDialog;
};
 
 
 
// InputApp
 
 
struct InputApp : public uiApp {
  InputApp(InputForm * form_)      { form = form_; }
  virtual void init()              { form->init(this, false); }
 
  InputForm * form;
};
 
 
 
 
// TextInputForm
 
 
struct TextInputForm : public InputForm {
  TextInputForm(InputBox * inputBox_)
    : InputForm(inputBox_)
  {
  }
 
  void addControls();
  void calcRequiredSize();
  void finalize();
 
  char const *     labelText;
  char *           inOutString;
  int              maxLength;
  bool             passwordMode;
 
  int              editExtent;
  int              labelExtent;
 
  uiTextEdit *     edit;
};
 
 
 
// MessageForm
 
 
struct MessageForm : public InputForm {
  MessageForm(InputBox * inputBox_)
    : InputForm(inputBox_)
  {
  }
 
  void addControls();
  void calcRequiredSize();
  void finalize();
 
  char const *     messageText;
 
  int              messageExtent;
};
 
 
 
// SelectForm
 
 
struct SelectForm : public InputForm {
  SelectForm(InputBox * inputBox_)
    : InputForm(inputBox_)
  {
  }
 
  void addControls();
  void calcRequiredSize();
  void finalize();
 
  int countItems(size_t * maxLength);
 
  char const *     messageText;
  char const *     items;       // "separator" separated items (zero ends the list)
  char             separator;
  StringList *     itemsList;
  bool             menuMode;
 
  int              listBoxHeight;
  int              outSelected;
 
  uiListBox *      listBox;
};
 
 
 
// ProgressForm
 
 
struct ProgressForm : public InputForm {
  ProgressForm(InputBox * inputBox_)
    : InputForm(inputBox_)
  {
  }
 
  void addControls();
  void calcRequiredSize();
  void show();
 
  bool update(int percentage, char const * format, ...);
 
  static const int        progressBarHeight = 16;
 
  bool                    hasProgressBar;
  Delegate<ProgressForm*> execFunc;
  int                     width;
 
  uiLabel *               label;
  uiProgressBar *         progressBar;
};
 
 
 
// FileBrowserForm
 
 
struct FileBrowserForm : public InputForm {
  static constexpr int SIDE_BUTTONS_WIDTH  = 65;
  static constexpr int SIDE_BUTTONS_HEIGHT = 18;
  static constexpr int CTRLS_DIST          = 4;
  static constexpr int BROWSER_WIDTH       = 150;
  static constexpr int BROWSER_HEIGHT      = 242;
  static constexpr int MAXNAME             = 32;
 
  FileBrowserForm(InputBox * inputBox_)
    : InputForm(inputBox_)
  {
  }
  ~FileBrowserForm() {
    free(srcDirectory);
    free(srcFilename);
  }
  void doCopy();
  void doPaste();
 
  void addControls();
  void calcRequiredSize();
  void finalize();
 
  char const *    directory;
 
  char *          srcDirectory = nullptr;
  char *          srcFilename  = nullptr;
 
  uiFileBrowser * fileBrowser;
  uiButton *      newFolderButton;
  uiButton *      renameButton;
  uiButton *      deleteButton;
  uiButton *      copyButton;
  uiButton *      pasteButton;
};
 
 
 
// FileSelectorForm
 
struct FileSelectorForm : public InputForm {
  static constexpr int CTRLS_DIST          = 4;
  static constexpr int BROWSER_WIDTH       = 180;
  static constexpr int BROWSER_HEIGHT      = 150;
  static constexpr int MINIMUM_EDIT_WIDTH  = 64;
 
  FileSelectorForm(InputBox * inputBox_)
    : InputForm(inputBox_)
  {
  }
 
  void addControls();
  void calcRequiredSize();
  void finalize();
 
  char const *     labelText;
  char *           inOutDirectory;
  int              maxDirectoryLength;
  char *           inOutFilename;
  int              maxFilenameLength;
 
  int              editExtent;
  int              labelExtent;
 
  uiTextEdit *     edit;
  uiFileBrowser *  fileBrowser;
};
 
 
 
// InputBox
 
 
class InputBox {
 
public:
 
  InputBox(uiApp * app = nullptr);
 
  ~InputBox();
 
  void begin(char const * modeline = nullptr, int viewPortWidth = -1, int viewPortHeight = -1, int displayColors = 16);
 
  void begin(BitmappedDisplayController * displayController);
 
  BitmappedDisplayController * getDisplayController()                        { return m_dispCtrl; }
 
  void end();
 
  void setBackgroundColor(RGB888 const & value)   { m_backgroundColor = value; }
 
  RGB888 backgroundColor()                        { return m_backgroundColor; }
 
  void setAutoOK(int timeout)                     { m_autoOK = timeout; }
 
  void setupButton(int index, char const * text, char const * subItems = nullptr, int subItemsHeight = 80);
 
  void setMinButtonsWidth(int value)                   { m_minButtonsWidth = value; }
 
  int minButtonsWidth()                                { return m_minButtonsWidth; }
 
  char const * buttonText(int index)                   { return m_buttonText[index]; }
 
  char const * buttonSubItems(int index)               { return m_buttonSubItems[index]; }
 
  int buttonsSubItemsHeight(int index)                 { return m_buttonSubItemsHeight[index]; }
 
  InputResult getLastResult()                          { return m_lastResult; }
 
  int selectedSubItem()                                { return m_buttonSubItem; }
 
  InputResult textInput(char const * titleText, char const * labelText, char * inOutString, int maxLength, char const * buttonCancelText = "Cancel", char const * buttonOKText = "OK", bool passwordMode = false);
 
  InputResult message(char const * titleText, char const * messageText, char const * buttonCancelText = nullptr, char const * buttonOKText = "OK");
 
  InputResult messageFmt(char const * titleText, char const * buttonCancelText, char const * buttonOKText, const char *format, ...);
 
  int select(char const * titleText, char const * messageText, char const * itemsText, char separator = ';', char const * buttonCancelText = "Cancel", char const * buttonOKText = "OK");
 
  InputResult select(char const * titleText, char const * messageText, StringList * items, char const * buttonCancelText = "Cancel", char const * buttonOKText = "OK");
 
  int menu(char const * titleText, char const * messageText, char const * itemsText, char separator = ';');
 
  int menu(char const * titleText, char const * messageText, StringList * items);
 
  template <typename Func>
  InputResult progressBox(char const * titleText, char const * buttonCancelText, bool hasProgressBar, int width, Func execFunc) {
    ProgressForm form(this);
    form.execFunc = execFunc;
    return progressBoxImpl(form, titleText, buttonCancelText, hasProgressBar, width);
  }
 
  InputResult folderBrowser(char const * titleText, char const * directory = "/", char const * buttonOKText = "Close");
 
  InputResult fileSelector(char const * titleText, char const * messageText, char * inOutDirectory, int maxDirectoryLength, char * inOutFilename, int maxFilenameLength, char const * buttonCancelText = "Cancel", char const * buttonOKText = "OK");
 
 
  // delegates
 
  Delegate<Canvas *> onPaint;
  
 
 
private:
 
  InputResult progressBoxImpl(ProgressForm & form, char const * titleText, char const * buttonCancelText, bool hasProgressBar, int width);
 
  void exec(InputForm * form);
  void resetButtons();
 
  BitmappedDisplayController * m_dispCtrl;
  VGAPalettedController      * m_vgaCtrl;
  RGB888                       m_backgroundColor;
  uiApp *                      m_existingApp;                               // uiApp in case of running on existing app
  uint16_t                     m_autoOK;                                    // auto ok in seconds
  int16_t                      m_buttonSubItem;                             // in case of button with subitems, specifies the selected subitem                     //
  char const *                 m_buttonText[InputForm::BUTTONS]     = { };
  char const *                 m_buttonSubItems[InputForm::BUTTONS] = { };  // ext button is uiButton is nullptr, uiSplitButton otherwise
  uint16_t                     m_buttonSubItemsHeight[InputForm::BUTTONS] = { };
  InputResult                  m_lastResult = InputResult::None;
  int16_t                      m_minButtonsWidth;
};
 
 
 
}   // namespace fabgl