← Back to branch summary

~ubuntu-branches/ubuntu/karmic/gears/karmic

« back to all changes in this revision

Viewing changes to gears/ui/common/html_dialog.h

  • Committer: Bazaar Package Importer
  • Author(s): Stefan Lesicnik
  • Date: 2009-04-30 19:15:25 UTC
  • Revision ID: james.westby@ubuntu.com-20090430191525-0790sb5wzg8ou0xb
Tags: upstream-0.5.21.0~svn3334+dfsg
Import upstream version 0.5.21.0~svn3334+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
gears/ui/common/html_dialog.h
 
1
// Copyright 2007, Google Inc.
 
2
//
 
3
// Redistribution and use in source and binary forms, with or without 
 
4
// modification, are permitted provided that the following conditions are met:
 
5
//
 
6
//  1. Redistributions of source code must retain the above copyright notice, 
 
7
//     this list of conditions and the following disclaimer.
 
8
//  2. Redistributions in binary form must reproduce the above copyright notice,
 
9
//     this list of conditions and the following disclaimer in the documentation
 
10
//     and/or other materials provided with the distribution.
 
11
//  3. Neither the name of Google Inc. nor the names of its contributors may be
 
12
//     used to endorse or promote products derived from this software without
 
13
//     specific prior written permission.
 
14
//
 
15
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
 
16
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
 
17
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 
18
// EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 
19
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 
20
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 
21
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 
22
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
 
23
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
 
24
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
25
 
 
26
#ifndef GEARS_UI_COMMON_HTML_DIALOG_H__
 
27
#define GEARS_UI_COMMON_HTML_DIALOG_H__
 
28
 
 
29
#include "gears/base/common/string16.h"
 
30
#include "third_party/jsoncpp/json.h"
 
31
 
 
32
class BrowsingContext;
 
33
 
 
34
// Return values for showing dialogs. If the dialog returns SUPRESSED, it means
 
35
// that the SupressDialog preference in PermissionsDB is enabled for automated
 
36
// testing.
 
37
enum HtmlDialogReturnValue {
 
38
  HTML_DIALOG_SUCCESS,
 
39
  HTML_DIALOG_FAILURE,
 
40
  HTML_DIALOG_SUPPRESSED
 
41
};
 
42
 
 
43
// This class implements a cross-platform modal dialog using HTML for the
 
44
// dialog UI. We use HTML because it's easy to create nice-looking UIs that
 
45
// work across platforms.
 
46
//
 
47
// Arguments and results are passed to JavaScript inside the dialog by way of
 
48
// JSON because that is easier and more flexible than mucking about with
 
49
// cross-platform VARIANT types.
 
50
//
 
51
// TODO(aa): The Json arguments and result fields want UTF-8 strings, but we
 
52
// use UTF-16 everywhere else in Gears. What can we do about this? Change
 
53
// jsoncpp? Or wrap it?
 
54
class HtmlDialog {
 
55
 public:
 
56
  typedef void (* ModelessCompletionCallback)(Json::Value *result, 
 
57
                                              void *closure);
 
58
 public:
 
59
  // Constructor.
 
60
  HtmlDialog(BrowsingContext *browsing_context)
 
61
      : arguments(Json::objectValue),
 
62
        result(Json::nullValue),
 
63
        browsing_context_(browsing_context) {}
 
64
 
 
65
  // Open the dialog.
 
66
  HtmlDialogReturnValue DoModal(const char16 *html_filename, int width,
 
67
                                int height);
 
68
  
 
69
  // Open the dialog and call the callback when it's closed.
 
70
  HtmlDialogReturnValue DoModeless(const char16 *html_filename, int width,
 
71
                                   int height,
 
72
                                   ModelessCompletionCallback callback,
 
73
                                   void *closure);
 
74
 
 
75
  // Parses the result from the dialog and assings to result_.
 
76
  bool SetResult(const char16 *result_string);
 
77
 
 
78
  // The arguments object that will be serialized to pass to the dialog.
 
79
  Json::Value arguments;
 
80
 
 
81
  // The results that were returned from the dialog.
 
82
  Json::Value result;
 
83
 
 
84
 private:
 
85
  // Platform-specific implementation of DoModal().
 
86
  bool DoModalImpl(const char16 *html_filename, int width, int height,
 
87
                   const char16 *arguments_string);
 
88
 
 
89
  bool DoModelessImpl(const char16 *html_filename, int width, int height,
 
90
                      const char16 *arguments_string,
 
91
                      ModelessCompletionCallback callback,
 
92
                      void *closure);
 
93
 
 
94
  // GetLocale() is in the browser-specific HtmlDialog code.
 
95
  bool GetLocale(std::string16 *locale);
 
96
 
 
97
  BrowsingContext *browsing_context_;
 
98
};
 
99
 
 
100
#endif  // GEARS_UI_COMMON_HTML_DIALOG_H__