platform_presets.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_WIDGET_PRESETS_HPP
#define ADOBE_WIDGET_PRESETS_HPP

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

#include <adobe/future/widgets/headers/widget_utils.hpp>
#include <adobe/future/widgets/headers/macintosh_metric_extractor.hpp>
#include <adobe/future/widgets/headers/platform_popup.hpp>

#include <adobe/eve.hpp>
#include <adobe/future/macintosh_events.hpp>
#include <adobe/future/widgets/headers/widget_factory.hpp>
#include <adobe/macintosh_carbon_safe.hpp>

#include <boost/function.hpp>
#include <boost/operators.hpp>
#include <boost/filesystem/path.hpp>
#include <boost/type_traits.hpp>
#include <boost/static_assert.hpp>

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

namespace adobe {

/****************************************************************************************************/
#ifndef ADOBE_NO_DOCUMENTATION
struct sheet_t;
struct assemblage_t;

struct presets_t;

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

typedef boost::function<dictionary_t ()> model_snapshot_proc_t;
typedef popup_t::setter_type                    preset_setter_type;

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

struct presets_hit_handler_t
{
    explicit presets_hit_handler_t(presets_t& widget) :
        widget_m(widget)
    {
        handler_m.insert(kEventClassControl, kEventControlClick);

        handler_m.monitor_proc_m = boost::bind(&presets_hit_handler_t::handle_event,
                                               boost::ref(*this), _1, _2);
    }

    ::OSStatus handle_event(::EventHandlerCallRef next,
                            ::EventRef            event);

    event_handler_t    handler_m;
    preset_setter_type setter_m;
    presets_t&         widget_m;
};
#endif
/****************************************************************************************************/

struct presets_t
{
    typedef dictionary_t model_type;

    typedef preset_setter_type setter_type;

    presets_t(const std::string&         name,
              const std::string&         domain,
              const std::string&         alt_text,
              const array_t&      bind_set,
              const dictionary_t& localization_set,
              theme_t                    theme);

#ifndef ADOBE_NO_DOCUMENTATION
    presets_t(const presets_t& rhs);

    presets_t& operator=(const presets_t& rhs);
#endif

    void measure(extents_t& result);

    void place(const place_data_t& place_data);

    void display(const model_type& value);

    void display_additional_preset_set(const array_t& value);

    void monitor(const setter_type& proc)
    { proc_m = proc; }

    void snapshot_callback(const model_snapshot_proc_t& proc)
    { snapshot_proc_m = proc; }

#ifndef ADOBE_NO_DOCUMENTATION
    ::ControlRef               control_m;        // the preset icon
    popup_t                    category_popup_m; // the category popup
    popup_t                    popup_m;          // the actual preset popup
    theme_t                    theme_m;
    mutable metric_extractor_t metrics_m;
    presets_hit_handler_t      hit_handler_m;    // hit handler for the preset icon
    array_t             bind_set_m;       // the set of parameters to be stored in the preset
    std::string                name_m;
    std::string                domain_m;
    std::string                alt_text_m;
    bool                       selected_m;       // whether or not the preset icon is pushed
    model_snapshot_proc_t      snapshot_proc_m;
    long                       popup_height_m;
    dictionary_t        localization_set_m;
    dictionary_t        last_m;
    bool                       type_2_debounce_m;
    setter_type                proc_m;
    bool                       custom_m;

    // these store the various preset sources as arrays
    array_t             dynamic_preset_set_m;
    array_t             default_preset_set_m;
    array_t             user_preset_set_m;
    array_t             composite_m;

    void do_imbue(const popup_t::model_type& value);

private:
    void display_custom();
#endif
};

/****************************************************************************************************/
#ifndef ADOBE_NO_DOCUMENTATION
inline ::HIViewRef get_display(presets_t& widget)
    { return widget.control_m; }
#endif
/****************************************************************************************************/

void enable(presets_t& value, bool make_enabled);

/****************************************************************************************************/
#ifndef ADOBE_NO_DOCUMENTATION
bool operator==(const presets_t& x, const presets_t& y);
#endif
/****************************************************************************************************/

} // namespace adobe

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

#endif

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