eve.hpp

Go to the documentation of this file.

/*
    Copyright 2005-2007 Adobe Systems Incorporated
    Distributed under the MIT License (see accompanying file LICENSE_1_0_0.txt
    or a copy at http://stlab.adobe.com/licenses.html)
*/

/*************************************************************************************************/

#ifndef ADOBE_EVE_HPP
#define ADOBE_EVE_HPP

#include <adobe/config.hpp>

#include <utility>

#include <boost/noncopyable.hpp>

#include <adobe/forest.hpp>
#include <adobe/extents.hpp>
#include <adobe/poly_placeable.hpp>
#include <adobe/layout_attributes.hpp>

/*************************************************************************************************/

namespace adobe {
namespace implementation {

/*************************************************************************************************/

struct view_proxy_t;

/*************************************************************************************************/

} // namespace implementation
} // namespace adobe

/*************************************************************************************************/

#if !defined(ADOBE_NO_DOCUMENTATION)
namespace boost {
namespace detail {
    template <>
    struct is_pod_impl<adobe::implementation::view_proxy_t>
    {
        BOOST_STATIC_CONSTANT(bool, value = true);
    };
}
}
#endif

/*************************************************************************************************/

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);


    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);
  
 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

/*************************************************************************************************/