IGUIEnvironment.hpp

// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in nirtcpp/nirtcpp.hpp
 
#ifndef NIRT_I_GUI_ENVIRONMENT_HPP_INCLUDED
#define NIRT_I_GUI_ENVIRONMENT_HPP_INCLUDED
 
#include <nirtcpp/core/engine/IReferenceCounted.hpp>
#include <nirtcpp/core/engine/IGUISkin.hpp>
#include <nirtcpp/core/engine/rect.hpp>
#include <nirtcpp/core/engine/EMessageBoxFlags.hpp>
#include <nirtcpp/core/engine/EFocusFlags.hpp>
#include <nirtcpp/core/engine/IEventReceiver.hpp>
#include <nirtcpp/core/engine/IXMLReader.hpp>
#include <nirtcpp/core/engine/IXMLWriter.hpp>
#include <nirtcpp/core/engine/path.hpp>
 
namespace nirt
{
    class IOSOperator;
    class IEventReceiver;
 
    namespace io
    {
        class IReadFile;
        class IWriteFile;
        class IFileSystem;
    } // end namespace io
    namespace video
    {
        class IVideoDriver;
        class ITexture;
    } // end namespace video
 
namespace gui
{
 
class IGUIElement;
class IGUIFont;
class IGUISpriteBank;
class IGUIScrollBar;
class IGUIImage;
class IGUIMeshViewer;
class IGUICheckBox;
class IGUIListBox;
class IGUITreeView;
class IGUIImageList;
class IGUIFileOpenDialog;
class IGUIColorSelectDialog;
class IGUIInOutFader;
class IGUIStaticText;
class IGUIEditBox;
class IGUISpinBox;
class IGUITabControl;
class IGUITab;
class IGUITable;
class IGUIContextMenu;
class IGUIComboBox;
class IGUIToolBar;
class IGUIButton;
class IGUIWindow;
class IGUIProfiler;
class IGUIElementFactory;
 
 
class IGUIEnvironment : public virtual IReferenceCounted
{
public:
 
 
    virtual void drawAll(bool useScreenSize=true) = 0;
 
 
    virtual bool setFocus(IGUIElement* element) = 0;
 
 
    virtual IGUIElement* getFocus() const = 0;
 
 
    virtual IGUIElement* getHovered() const = 0;
 
 
    virtual bool removeFocus(IGUIElement* element) = 0;
 
 
    virtual bool hasFocus(const IGUIElement* element, bool checkSubElements=false) const = 0;
 
 
    virtual video::IVideoDriver* getVideoDriver() const = 0;
 
 
    virtual io::IFileSystem* getFileSystem() const = 0;
 
 
    virtual IOSOperator* getOSOperator() const = 0;
 
    virtual void clear() = 0;
 
 
    virtual bool postEventFromUser(const SEvent& event) = 0;
 
 
    virtual void setUserEventReceiver(IEventReceiver* evr) = 0;
 
 
    virtual IGUISkin* getSkin() const = 0;
 
 
    virtual void setSkin(IGUISkin* skin) = 0;
 
 
    virtual IGUISkin* createSkin(EGUI_SKIN_TYPE type) = 0;
 
 
 
    virtual IGUIImageList* createImageList( video::ITexture* texture,
                    core::dimension2d<s32> imageSize,
                    bool useAlphaChannel ) = 0;
 
 
    virtual IGUIFont* getFont(const io::path& filename) = 0;
 
 
    virtual IGUIFont* addFont(const io::path& name, IGUIFont* font) = 0;
 
    virtual void removeFont(IGUIFont* font) = 0;
 
 
    virtual IGUIFont* getBuiltInFont() const = 0;
 
 
    virtual IGUISpriteBank* getSpriteBank(const io::path& filename) = 0;
 
 
    virtual IGUISpriteBank* addEmptySpriteBank(const io::path& name) = 0;
 
 
    virtual IGUIElement* getRootGUIElement() = 0;
 
 
    virtual IGUIButton* addButton(const core::rect<s32>& rectangle,
        IGUIElement* parent=0, s32 id=-1, const wchar_t* text=0, const wchar_t* tooltiptext = 0) = 0;
 
 
    virtual IGUIWindow* addWindow(const core::rect<s32>& rectangle, bool modal = false,
        const wchar_t* text=0, IGUIElement* parent=0, s32 id=-1) = 0;
 
 
    virtual IGUIElement* addModalScreen(IGUIElement* parent, int blinkMode = 3) = 0;
 
 
    virtual IGUIWindow* addMessageBox(const wchar_t* caption, const wchar_t* text=0,
        bool modal = true, s32 flags = EMBF_OK, IGUIElement* parent=0, s32 id=-1, video::ITexture* image=0) = 0;
 
 
    virtual IGUIScrollBar* addScrollBar(bool horizontal, const core::rect<s32>& rectangle,
        IGUIElement* parent=0, s32 id=-1) = 0;
 
 
    virtual IGUIImage* addImage(video::ITexture* image, core::position2d<s32> pos,
        bool useAlphaChannel=true, IGUIElement* parent=0, s32 id=-1, const wchar_t* text=0) = 0;
 
 
    virtual IGUIImage* addImage(const core::rect<s32>& rectangle,
        IGUIElement* parent=0, s32 id=-1, const wchar_t* text=0, bool useAlphaChannel=true) = 0;
 
 
    virtual IGUICheckBox* addCheckBox(bool checked, const core::rect<s32>& rectangle,
        IGUIElement* parent=0, s32 id=-1, const wchar_t* text=0) = 0;
 
 
    virtual IGUIListBox* addListBox(const core::rect<s32>& rectangle,
        IGUIElement* parent=0, s32 id=-1, bool drawBackground=false) = 0;
 
 
    virtual IGUITreeView* addTreeView(const core::rect<s32>& rectangle,
        IGUIElement* parent=0, s32 id=-1, bool drawBackground=false,
        bool scrollBarVertical = true, bool scrollBarHorizontal = false) = 0;
 
 
    virtual IGUIMeshViewer* addMeshViewer(const core::rect<s32>& rectangle,
            IGUIElement* parent=0, s32 id=-1, const wchar_t* text=0) = 0;
 
 
    virtual IGUIFileOpenDialog* addFileOpenDialog(const wchar_t* title=0,
        bool modal=true, IGUIElement* parent=0, s32 id=-1,
        bool restoreCWD=false, io::path::char_type* startDir=0) = 0;
 
 
    virtual IGUIColorSelectDialog* addColorSelectDialog(const wchar_t* title = 0,
        bool modal=true, IGUIElement* parent=0, s32 id=-1) = 0;
 
 
    virtual IGUIStaticText* addStaticText(const wchar_t* text, const core::rect<s32>& rectangle,
        bool border=false, bool wordWrap=true, IGUIElement* parent=0, s32 id=-1,
        bool fillBackground = false) = 0;
 
 
    virtual IGUIEditBox* addEditBox(const wchar_t* text, const core::rect<s32>& rectangle,
        bool border=true, IGUIElement* parent=0, s32 id=-1) = 0;
 
 
    virtual IGUISpinBox* addSpinBox(const wchar_t* text, const core::rect<s32>& rectangle,
        bool border=true,IGUIElement* parent=0, s32 id=-1) = 0;
 
 
    virtual IGUIInOutFader* addInOutFader(const core::rect<s32>* rectangle=0, IGUIElement* parent=0, s32 id=-1) = 0;
 
 
    virtual IGUITabControl* addTabControl(const core::rect<s32>& rectangle,
        IGUIElement* parent=0, bool fillbackground=false,
        bool border=true, s32 id=-1) = 0;
 
 
    virtual IGUITab* addTab(const core::rect<s32>& rectangle,
        IGUIElement* parent=0, s32 id=-1) = 0;
 
 
    virtual IGUIContextMenu* addContextMenu(const core::rect<s32>& rectangle,
        IGUIElement* parent=0, s32 id=-1) = 0;
 
 
    virtual IGUIContextMenu* addMenu(IGUIElement* parent=0, s32 id=-1) = 0;
 
 
    virtual IGUIToolBar* addToolBar(IGUIElement* parent=0, s32 id=-1) = 0;
 
 
    virtual IGUIComboBox* addComboBox(const core::rect<s32>& rectangle,
        IGUIElement* parent=0, s32 id=-1) = 0;
 
 
    virtual IGUITable* addTable(const core::rect<s32>& rectangle,
        IGUIElement* parent=0, s32 id=-1, bool drawBackground=false) =0;
 
 
    virtual IGUIProfiler* addProfilerDisplay(const core::rect<s32>& rectangle,
        IGUIElement* parent=0, s32 id=-1) = 0;
 
 
    virtual IGUIElementFactory* getDefaultGUIElementFactory() const = 0;
 
 
    virtual void registerGUIElementFactory(IGUIElementFactory* factoryToAdd) = 0;
 
 
    virtual u32 getRegisteredGUIElementFactoryCount() const = 0;
 
 
    virtual IGUIElementFactory* getGUIElementFactory(u32 index) const = 0;
 
 
    virtual IGUIElement* addGUIElement(const c8* elementName, IGUIElement* parent=0) = 0;
 
 
    virtual bool saveGUI(const io::path& filename, IGUIElement* start=0) = 0;
 
 
    virtual bool saveGUI(io::IWriteFile* file, IGUIElement* start=0) = 0;
 
 
    virtual bool loadGUI(const io::path& filename, IGUIElement* parent=0) = 0;
 
 
    virtual bool loadGUI(io::IReadFile* file, IGUIElement* parent=0) = 0;
 
    virtual void serializeAttributes(io::IAttributes* out, io::SAttributeReadWriteOptions* options=0) const =0;
 
    virtual void deserializeAttributes(io::IAttributes* in, io::SAttributeReadWriteOptions* options=0)=0;
 
    virtual void writeGUIElement(io::IXMLWriter* writer, IGUIElement* element) =0;
 
    virtual void readGUIElement(io::IXMLReader* reader, IGUIElement* element) =0;
 
 
    virtual IGUIElement* getNextElement(bool reverse=false, bool group=false) = 0;
 
 
    virtual void setFocusBehavior(u32 flags) = 0;
 
 
    virtual u32 getFocusBehavior() const = 0;
 
 
    virtual void addToDeletionQueue(IGUIElement* element) = 0;
};
 
 
} // end namespace gui
} // end namespace nirt
 
#endif