IGUIEditBox.h

Go to the documentation of this file.

// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h

#ifndef __I_GUI_EDIT_BOX_H_INCLUDED__
#define __I_GUI_EDIT_BOX_H_INCLUDED__

#include "IGUIElement.h"
#include "SColor.h"

namespace irr
{
namespace gui
{
        class IGUIFont;


        class IGUIEditBox : public IGUIElement
        {
        public:

                IGUIEditBox(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
                        : IGUIElement(EGUIET_EDIT_BOX, environment, parent, id, rectangle) {}


                virtual void setOverrideFont(IGUIFont* font=0) = 0;


                virtual IGUIFont* getOverrideFont() const = 0;


                virtual IGUIFont* getActiveFont() const = 0;


                virtual void setOverrideColor(video::SColor color) = 0;

                virtual video::SColor getOverrideColor() const = 0;


                virtual void enableOverrideColor(bool enable) = 0;


                virtual bool isOverrideColorEnabled(void) const = 0;

                virtual void setDrawBackground(bool draw) = 0;


                virtual bool isDrawBackgroundEnabled() const = 0;


                virtual void setDrawBorder(bool border) = 0;


                virtual bool isDrawBorderEnabled() const = 0;


                virtual void setTextAlignment(EGUI_ALIGNMENT horizontal, EGUI_ALIGNMENT vertical) = 0;


                virtual void setWordWrap(bool enable) = 0;


                virtual bool isWordWrapEnabled() const = 0;


                virtual void setMultiLine(bool enable) = 0;


                virtual bool isMultiLineEnabled() const = 0;


                virtual void setAutoScroll(bool enable) = 0;


                virtual bool isAutoScrollEnabled() const = 0;


                virtual void setPasswordBox(bool passwordBox, wchar_t passwordChar = L'*') = 0;

                virtual bool isPasswordBox() const = 0;


                virtual core::dimension2du getTextDimension() = 0;


                virtual void setMax(u32 max) = 0;

                virtual u32 getMax() const = 0;


                virtual void setCursorChar(const wchar_t cursorChar) = 0;

                virtual wchar_t getCursorChar() const = 0;

                //** \param timeMs Blinktime in milliseconds. When set to 0 the cursor is constantly on without blinking */
                virtual void setCursorBlinkTime(irr::u32 timeMs) = 0;

                virtual irr::u32 getCursorBlinkTime() const = 0;
        };


} // end namespace gui
} // end namespace irr

#endif