UIWidget.hpp

/******************************************************************************
 
  nomlib - C++11 cross-platform game engine
 
Copyright (c) 2013, 2014 Jeffrey Carpenter <i8degrees@gmail.com>
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
******************************************************************************/
#ifndef NOMLIB_GUI_UIWIDGET_HPP
#define NOMLIB_GUI_UIWIDGET_HPP
 
#include <string>
 
#include "nomlib/config.hpp"
#include "nomlib/math/Point2.hpp"
#include "nomlib/math/Size2.hpp"
#include "nomlib/gui/RocketUtilities.hpp"
 
namespace nom {
 
// Forward declarations
class UIEventListener;
class UIContext;
 
class UIWidget
{
  public:
    typedef UIWidget self_type;
    typedef self_type* raw_ptr;
 
    enum FocusPolicy
    {
      NONE = rocket::ElementDocument::FocusFlags::NONE,
      FOCUS = rocket::ElementDocument::FocusFlags::FOCUS,
      MODAL = rocket::ElementDocument::FocusFlags::MODAL
    };

    UIWidget();

    virtual ~UIWidget();

    virtual Point2i position() const;

    virtual Size2i size() const;

    virtual void set_position( const Point2i& pos );

    virtual void set_size( const Size2i& dims );

    UIContext* context() const;

    rocket::ElementDocument* document() const;
 
    bool valid() const;
    bool valid( rocket::Element* target ) const;
    bool visible() const;
 
    const std::string& title_id() const;
    std::string title() const;

    uint32 text_alignment( rocket::Element* target ) const;
 
    bool set_context(UIContext* ctx);
 
    bool load_document_file( const std::string& filename );
 
    void show();
    void hide();
    void close();

    void set_focus( uint32 focus = FocusPolicy::FOCUS );

    bool hit_test( rocket::Element* target, const Point2i& pt );
 
    void set_title( const std::string& text );
 
    void set_title_id( const std::string& id );
 
    void set_font( rocket::Element* target, const std::string& font );
    void set_font_size( rocket::Element* target, int point_size );
 
    bool set_alignment(uint32 alignment);

    void set_text_alignment( rocket::Element* element, uint32 alignment );

    void register_event_listener( rocket::Element* element,
                                  const std::string& ev,
                                  UIEventListener* observer,
                                  bool interruptible = false );
 
  private:
    UIContext* ctx_;

    rocket::ElementDocument* document_;
 
    std::string title_id_;
};
 
} // namespace nom
 
#endif // include guard defined