modal_dialog_interface.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)
*/

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

#include <adobe/dictionary.hpp>
#include <adobe/array.hpp>

#include <boost/function.hpp>
#include <boost/filesystem/path.hpp>

#include <utility>

#if ADOBE_PLATFORM_WIN
#include <windows.h>
#endif

#include <adobe/future/platform_primitives.hpp>
#include <adobe/future/widgets/headers/factory.hpp>
#include <adobe/future/widgets/headers/virtual_machine_extension.hpp>

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

namespace adobe {

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

/****************************************************************************************************/
enum display_options_t
{
    dialog_display_s,

    dialog_no_display_s,

    dialog_never_display_s
};

/****************************************************************************************************/
struct dialog_result_t
{
    dialog_result_t& operator=(const dialog_result_t& x)
    {
        record_m                = x.record_m;
        display_state_m         = x.display_state_m;
        command_m               = x.command_m;
        terminating_action_m    = x.terminating_action_m;
        return *this;
    }
    dictionary_t record_m;

    dictionary_t display_state_m;

    dictionary_t command_m;

    name_t terminating_action_m;
};

/****************************************************************************************************/
typedef boost::function <bool (name_t, const any_regular_t&)> action_callback_t;

/****************************************************************************************************/
class modal_dialog_t
{
public:
    typedef any_regular_t               model_type;
    typedef auto_ptr<eve_client_holder> auto_view_t;

    modal_dialog_t();

    dialog_result_t go(std::istream& layout, std::istream& sheet);

    dictionary_t            input_m;
    dictionary_t            record_m;
    dictionary_t            display_state_m;
    display_options_t       display_options_m;
    action_callback_t       callback_m;
    boost::filesystem::path working_directory_m;
    platform_display_type   parent_m;
    vm_lookup_t             vm_lookup_m;

    /* Clients: no need to call these. */
    bool end_dialog();
    void display(const model_type& value);

private:
    void              latch_callback(name_t action, const any_regular_t&);

    void              monitor_record(const dictionary_t& record_info);
    void              monitor_invariant(bool valid);

    sheet_t           sheet_m;
    behavior_t        root_behavior_m;
    auto_view_t       view_m;
    bool              defer_view_close_m;
    bool              need_ui_m;
    dialog_result_t   result_m;
    dictionary_t      contributing_m;
};

/****************************************************************************************************/
inline dialog_result_t handle_dialog(const dictionary_t&            input,
                                     const dictionary_t&            record,
                                     const dictionary_t&            display_state,
                                     display_options_t              display_options,
                                     std::istream&                  layout_definition,
                                     std::istream&                  sheet_definition,
                                     action_callback_t              callback,
                                     const boost::filesystem::path& working_directory,
                                     platform_display_type          parent=platform_display_type())
{
    assert ( !layout_definition.fail() );
    assert ( !sheet_definition.fail() );

    modal_dialog_t dialog;

    dialog.input_m = input;
    dialog.record_m = record;
    dialog.display_state_m = display_state;
    dialog.display_options_m = display_options;
    dialog.callback_m = callback;
    dialog.working_directory_m = working_directory;
    dialog.parent_m = parent;

    return dialog.go(layout_definition, sheet_definition);
}

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

} // namespace adobe

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