// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_UI_AUTOFILL_AUTOFILL_DIALOG_TYPES_H_
#define CHROME_BROWSER_UI_AUTOFILL_AUTOFILL_DIALOG_TYPES_H_
#include <map>
#include <vector>
#include "base/callback_forward.h"
#include "base/strings/string16.h"
#include "base/time/time.h"
#include "components/autofill/core/browser/autofill_metrics.h"
#include "components/autofill/core/browser/field_types.h"
#include "third_party/skia/include/core/SkColor.h"
#include "ui/gfx/font_list.h"
#include "ui/gfx/image/image.h"
#include "ui/gfx/range/range.h"
#include "ui/gfx/text_constants.h"
#include "url/gurl.h"
namespace autofill {
class AutofillField;
// This struct describes a single input control for the imperative autocomplete
// dialog.
struct DetailInput {
enum Length {
SHORT, // Shares a line with other short inputs, like display: inline.
SHORT_EOL, // Like SHORT but starts a new line directly afterward. Used to
// separate groups of short inputs into different lines.
LONG, // Will be given its own full line, like display: block.
NONE, // Input will not be shown.
};
// Returns whether this input can spread across multiple lines.
bool IsMultiline() const;
// Used to determine which inputs share lines when laying out.
Length length;
ServerFieldType type;
// Text shown when the input is at its default state (e.g. empty).
base::string16 placeholder_text;
// A number between 0 and 1.0 that describes how much of the horizontal space
// in the row should be allotted to this input. 0 is equivalent to 1.
float expand_weight;
// When non-empty, indicates the starting value for this input. This will be
// used when the user is editing existing data.
base::string16 initial_value;
};
// Sections of the dialog --- all fields that may be shown to the user fit under
// one of these sections.
enum DialogSection {
// Lower boundary value for looping over all sections.
SECTION_MIN,
// The Autofill-backed dialog uses separate CC and billing sections.
SECTION_CC = SECTION_MIN,
SECTION_BILLING,
// The wallet-backed dialog uses a combined CC and billing section.
SECTION_CC_BILLING,
SECTION_SHIPPING,
// Upper boundary value for looping over all sections.
SECTION_MAX = SECTION_SHIPPING
};
// A notification to show in the autofill dialog. Ranges from information to
// seriously scary security messages, and will give you the color it should be
// displayed (if you ask it).
class DialogNotification {
public:
enum Type {
NONE,
DEVELOPER_WARNING,
REQUIRED_ACTION,
SECURITY_WARNING,
WALLET_ERROR,
WALLET_USAGE_CONFIRMATION,
};
DialogNotification();
DialogNotification(Type type, const base::string16& display_text);
~DialogNotification();
// Returns the appropriate background, border, or text color for the view's
// notification area based on |type_|.
SkColor GetBackgroundColor() const;
SkColor GetBorderColor() const;
SkColor GetTextColor() const;
// Whether this notification has an arrow pointing up at the account chooser.
bool HasArrow() const;
// Whether this notifications has the "Save details to wallet" checkbox.
bool HasCheckbox() const;
Type type() const { return type_; }
const base::string16& display_text() const { return display_text_; }
void set_link_url(const GURL& link_url) { link_url_ = link_url; }
const GURL& link_url() const { return link_url_; }
const gfx::Range& link_range() const { return link_range_; }
void set_tooltip_text(const base::string16& tooltip_text) {
tooltip_text_ = tooltip_text;
}
const base::string16& tooltip_text() const { return tooltip_text_; }
void set_checked(bool checked) { checked_ = checked; }
bool checked() const { return checked_; }
private:
Type type_;
base::string16 display_text_;
// If the notification includes a link, these describe the destination and
// which part of |display_text_| is the anchor text.
GURL link_url_;
gfx::Range link_range_;
// When non-empty, indicates that a tooltip should be shown on the end of
// the notification.
base::string16 tooltip_text_;
// Whether the dialog notification's checkbox should be checked. Only applies
// when |HasCheckbox()| is true.
bool checked_;
};
extern SkColor const kWarningColor;
struct SuggestionState {
SuggestionState();
SuggestionState(bool visible,
const base::string16& vertically_compact_text,
const base::string16& horizontally_compact_text,
const gfx::Image& icon,
const base::string16& extra_text,
const gfx::Image& extra_icon);
~SuggestionState();
// Whether a suggestion should be shown.
bool visible;
// Text to be shown for the suggestion. This should be preferred over
// |horizontally_compact_text| when there's enough horizontal space available
// to display it. When there's not enough space, fall back to
// |horizontally_compact_text|.
base::string16 vertically_compact_text;
base::string16 horizontally_compact_text;
gfx::Image icon;
base::string16 extra_text;
gfx::Image extra_icon;
};
// A struct to describe a textual message within a dialog overlay.
struct DialogOverlayString {
DialogOverlayString();
~DialogOverlayString();
// Text content of the message.
base::string16 text;
// Font list to render the message's text in.
gfx::FontList font_list;
};
// A struct to describe a dialog overlay. If |image| is empty, no overlay should
// be shown.
struct DialogOverlayState {
DialogOverlayState();
~DialogOverlayState();
// If empty, there should not be an overlay. If non-empty, an image that is
// more or less front and center.
gfx::Image image;
// Message to display.
DialogOverlayString string;
};
enum ValidationType {
VALIDATE_EDIT, // Validate user edits. Allow for empty fields.
VALIDATE_FINAL, // Full form validation. Required fields can't be empty.
};
typedef std::vector<DetailInput> DetailInputs;
typedef std::map<ServerFieldType, base::string16> FieldValueMap;
// A validity message for a single input field.
struct ValidityMessage {
ValidityMessage(const base::string16& text, bool sure);
~ValidityMessage();
// Message text. If not empty, error text. If empty, indicates valid field.
base::string16 text;
// If |sure| is true, always display message. If it is false,
// only display on final validation (i.e. after the user has attempted to
// submit).
bool sure;
};
// A mapping of field types to their corresponding ValidityMessage results.
class ValidityMessages {
public:
ValidityMessages();
~ValidityMessages();
// Sets the message for |field|, but will not overwrite a previous, invalid
// message.
void Set(ServerFieldType field, const ValidityMessage& message);
const ValidityMessage& GetMessageOrDefault(ServerFieldType field) const;
bool HasSureError(ServerFieldType field) const;
bool HasErrors() const;
bool HasSureErrors() const;
private:
typedef std::map<ServerFieldType, ValidityMessage> MessageMap;
MessageMap messages_;
ValidityMessage default_message_;
};
} // namespace autofill
#endif // CHROME_BROWSER_UI_AUTOFILL_AUTOFILL_DIALOG_TYPES_H_