guiEditBox.h

Go to the documentation of this file.

/*
Minetest
Copyright (C) 2021 Minetest
 
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
 
This program 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 Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
 
#pragma once
 
#include "irrlichttypes.h"
#include "IGUIEditBox.h"
#include "IOSOperator.h"
#include "guiScrollBar.h"
#include <vector>
 
using namespace irr;
using namespace irr::gui;
 
class GUIEditBox : public IGUIEditBox
{
public:
    GUIEditBox(IGUIEnvironment *environment, IGUIElement *parent, s32 id,
            core::rect<s32> rectangle, bool border, bool writable) :
            IGUIEditBox(environment, parent, id, rectangle),
            m_border(border), m_writable(writable), m_frame_rect(rectangle)
    {
    }
 
    virtual ~GUIEditBox();
 
    virtual void setOverrideFont(IGUIFont *font = 0);
 
    virtual IGUIFont *getOverrideFont() const { return m_override_font; }
 
 
    virtual IGUIFont *getActiveFont() const;
 
    virtual void setOverrideColor(video::SColor color);
 
    virtual video::SColor getOverrideColor() const;
 
    virtual void enableOverrideColor(bool enable);
 
 
    virtual bool isOverrideColorEnabled(void) const
    {
        return m_override_color_enabled;
    }
 
    virtual void setWordWrap(bool enable);
 
    virtual bool isWordWrapEnabled() const { return m_word_wrap; }
 
    virtual void setDrawBorder(bool border);
 
    virtual bool isDrawBorderEnabled() const { return m_border; }
 
 
    virtual void setMultiLine(bool enable);
 
    virtual bool isMultiLineEnabled() const { return m_multiline; }
 
    virtual void setAutoScroll(bool enable);
 
    virtual bool isAutoScrollEnabled() const { return m_autoscroll; }
 
 
    virtual void setPasswordBox(bool passwordBox, wchar_t passwordChar = L'*');
 
    virtual bool isPasswordBox() const { return m_passwordbox; }
 
    virtual void setTextAlignment(EGUI_ALIGNMENT horizontal, EGUI_ALIGNMENT vertical);
 
    virtual void setText(const wchar_t *text);
 
    virtual void setMax(u32 max);
 
    virtual u32 getMax() const { return m_max; }
 
    virtual core::dimension2du getTextDimension();
 
    virtual void setWritable(bool can_write_text);
 
    virtual bool OnEvent(const SEvent &event);
 
    virtual bool acceptsIME() { return isEnabled() && m_writable; };
 
protected:
    virtual void breakText() = 0;
 
    virtual void setTextRect(s32 line) = 0;
 
    void setTextMarkers(s32 begin, s32 end);
 
    void sendGuiEvent(EGUI_EVENT_TYPE type);
 
    virtual void calculateScrollPos() = 0;
 
    virtual s32 getCursorPos(s32 x, s32 y) = 0;
 
    bool processKey(const SEvent &event);
    virtual void inputString(const core::stringw &str);
    virtual void inputChar(wchar_t c);
 
    s32 getLineFromPos(s32 pos);
 
    void updateVScrollBar();
 
    gui::IGUIFont *m_override_font = nullptr;
 
    bool m_override_color_enabled = false;
    bool m_word_wrap = false;
    bool m_multiline = false;
    bool m_autoscroll = true;
 
    bool m_border;
 
    bool m_passwordbox = false;
    wchar_t m_passwordchar = L'*';
 
    std::vector<core::stringw> m_broken_text;
    std::vector<s32> m_broken_text_positions;
 
    EGUI_ALIGNMENT m_halign = EGUIA_UPPERLEFT;
    EGUI_ALIGNMENT m_valign = EGUIA_CENTER;
 
    u32 m_blink_start_time = 0;
    s32 m_cursor_pos = 0;
    s32 m_hscroll_pos = 0;
    s32 m_vscroll_pos = 0; // scroll position in characters
    u32 m_max = 0;
 
    video::SColor m_override_color = video::SColor(101, 255, 255, 255);
 
    core::rect<s32> m_current_text_rect = core::rect<s32>(0, 0, 1, 1);
 
    bool m_writable;
 
    bool m_mouse_marking = false;
 
    s32 m_mark_begin = 0;
    s32 m_mark_end = 0;
 
    gui::IGUIFont *m_last_break_font = nullptr;
    IOSOperator *m_operator = nullptr;
 
    core::rect<s32> m_frame_rect; // temporary values
 
    u32 m_scrollbar_width = 0;
    GUIScrollBar *m_vscrollbar = nullptr;
 
private:
    bool processMouse(const SEvent &event);
 
    bool onKeyUp(const SEvent &event, s32 &mark_begin, s32 &mark_end);
    bool onKeyDown(const SEvent &event, s32 &mark_begin, s32 &mark_end);
    void onKeyControlC(const SEvent &event);
    bool onKeyControlX(const SEvent &event, s32 &mark_begin, s32 &mark_end);
    bool onKeyControlV(const SEvent &event, s32 &mark_begin, s32 &mark_end);
    bool onKeyBack(const SEvent &event, s32 &mark_begin, s32 &mark_end);
    bool onKeyDelete(const SEvent &event, s32 &mark_begin, s32 &mark_end);
};