platform_popup.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_POPUP_HPP
#define ADOBE_WIDGET_POPUP_HPP

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

#include <adobe/config.hpp>

#include <boost/smart_ptr.hpp>
#include <boost/static_assert.hpp>
#include <boost/type_traits.hpp>

#include <adobe/array.hpp>
#include <adobe/dictionary.hpp>
#include <adobe/extents.hpp>
#include <adobe/future/debounce.hpp>
#include <adobe/future/macintosh_events.hpp>
#include <adobe/future/widgets/headers/macintosh_metric_extractor.hpp>
#include <adobe/future/widgets/headers/popup_common_fwd.hpp>
#include <adobe/future/widgets/headers/widget_factory.hpp>
#include <adobe/future/widgets/headers/widget_utils.hpp>
#include <adobe/macintosh_carbon_safe.hpp>
#include <adobe/memory.hpp>

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

namespace adobe {

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

struct popup_t;

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

struct popup_value_handler_t
{
    explicit popup_value_handler_t(popup_t& widget) :
        widget_m(widget)
    {
        handler_m.insert(kEventClassControl, kEventControlValueFieldChanged);

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

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

    event_handler_t            handler_m;
    popup_setter_type          setter_m;
    popup_extended_setter_type extended_setter_m;
    popup_t&                   widget_m;
};

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

struct popup_key_handler_t
{
    popup_key_handler_t()
    {
        handler_m.insert(kEventClassTextInput, kEventTextInputUnicodeForKeyEvent);

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

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

    event_handler_t handler_m;
    popup_t*        popup_m;
};
#endif
/****************************************************************************************************/

struct popup_t
{
    typedef any_regular_t model_type;

    typedef popup_setter_type          setter_type;
    typedef popup_extended_setter_type extended_setter_type;

#ifndef ADOBE_NO_DOCUMENTATION
    typedef std::pair<std::string, any_regular_t> menu_item_t;
    typedef std::vector<menu_item_t> menu_item_set_t;
#endif

    popup_t(const std::string& name,
            const std::string& alt_text,
            const std::string& custom_item_name,
            const menu_item_t* first,
            const menu_item_t* last,
            theme_t            theme);

    void reset_menu_item_set(const menu_item_t* first, const menu_item_t* last);

    inline void reset_menu_item_set(const menu_item_set_t& menu_item_set)
    {
        const menu_item_t* first(menu_item_set.empty() ? 0 : &menu_item_set[0]);
        std::size_t        n(menu_item_set.size());

        reset_menu_item_set(first, first + n);
    }

    void select_with_text(const std::string& text);

    void measure(extents_t& result);

    void place(const place_data_t& place_data);

    void display(const any_regular_t& value);

    void monitor(const setter_type& proc);

    void enable(bool make_enabled);

    void monitor_extended(const extended_setter_type& extended_proc);

#ifndef ADOBE_NO_DOCUMENTATION
    ::ControlRef               control_m;
    theme_t                    theme_m;
    mutable metric_extractor_t metrics_m;
    std::string                name_m;
    std::string                alt_text_m;
    bool                       static_disabled_m;
    bool                       using_label_m;
    long                       label_width_m;
    menu_item_set_t            menu_items_m;
    popup_value_handler_t      value_handler_m;
    popup_key_handler_t        key_handler_m;
    bool                       type_2_debounce_m;
    any_regular_t              last_m;
    bool                       custom_m;
    std::string                custom_item_name_m;

private:
    void display_custom();
#endif
};

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

namespace view_implementation {

/****************************************************************************************************/
#ifndef ADOBE_NO_DOCUMENTATION
inline void set_value_from_model(popup_t& value, const any_regular_t& new_value)
{ value.display(new_value); }
#endif
/****************************************************************************************************/

} // namespace view_implementation

/****************************************************************************************************/
#ifndef ADOBE_NO_DOCUMENTATION
inline bool operator== (const popup_t& x, const popup_t& y)
{ return &x == &y; }
#endif
/****************************************************************************************************/

} // namespace adobe

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

#endif

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