eve.hpp

Go to the documentation of this file.

/*
    Copyright 2013 Adobe
    Distributed under the Boost Software License, Version 1.0.
    (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
*/
/**************************************************************************************************/
 
#ifndef ADOBE_EVE_HPP
#define ADOBE_EVE_HPP
 
#include <adobe/config.hpp>
 
#include <utility>
 
#include <boost/noncopyable.hpp>
 
#include <adobe/extents.hpp>
#include <adobe/forest.hpp>
#include <adobe/layout_attributes.hpp>
#include <adobe/poly_placeable.hpp>
 
/**************************************************************************************************/
 
namespace adobe {
namespace implementation {
 
/**************************************************************************************************/
 
struct view_proxy_t;
 
/**************************************************************************************************/
 
} // namespace implementation
} // namespace adobe
 
/**************************************************************************************************/
 
namespace adobe {
 
/**************************************************************************************************/
 

 
class eve_t
#if !defined(ADOBE_NO_DOCUMENTATION)
    : boost::noncopyable,
      public extents_slices_t,
      public layout_attributes_placement_t
#endif
{
public:
#if !defined(ADOBE_NO_DOCUMENTATION)
    typedef forest<implementation::view_proxy_t> proxy_tree_t;
    typedef proxy_tree_t::iterator iterator;
#endif
 

 
 
    enum evaluate_options_t {
        evaluate_nested, 
        evaluate_flat    
    };
 
    /*
        REVISIT (sparent) : I'm just starting a long cleanup of the Eve API - the steps should
       include the following:
 
        * eliminate the container default proc in favor of an inital extents setting.
        * rename calculate to calculate_horizontal - all calculation passes are optional (initial
       should often suffice).
    */
 
 
#if !defined(ADOBE_NO_DOCUMENTATION)
    explicit eve_t();
    ~eve_t();
#endif

 
    iterator add_placeable(iterator parent, const layout_attributes_t& initial,
                           bool is_container_type, poly_placeable_t& placeable,
                           bool reverse = false);

 
    void set_visible(iterator, bool);

 
    void set_layout_attributes(iterator, const layout_attributes_t&);

 
    std::pair<int, int> evaluate(evaluate_options_t options, int width = 0, int height = 0);
 

 
    std::pair<int, int> adjust(evaluate_options_t options, int width, int height);

    void print_debug(std::ostream& os);
 
private:
    friend struct implementation::view_proxy_t;
 
    class implementation_t;
    implementation_t* object_m;
};
 
 
/**************************************************************************************************/
 
void set_margin(layout_attributes_t& container, int x);
 
/**************************************************************************************************/
 
} // namespace adobe
 
/**************************************************************************************************/
 
#endif
 
/**************************************************************************************************/