Source/WebCore/html/HTMLInputElement.idl

/*
 * Copyright (C) 2006-2024 Apple Inc. All rights reserved.
 * Copyright (C) 2006 Samuel Weinig <sam.weinig@gmail.com>
 * Copyright (C) 2012 Samsung Electronics. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

enum AutofillVisibility {
    "normal",
    "visible",
    "hidden",
};

enum AutofillButtonType {
    "none",
    "credentials",
    "contacts",
    "strong-password",
    "credit-card",
    "loading"
};

[
    ExportMacro=WEBCORE_EXPORT,
    JSGenerateToNativeObject,
    Exposed=Window
] interface HTMLInputElement : HTMLElement {
    [CEReactions=NotNeeded, Reflect] attribute DOMString accept;
    [EnabledBySetting=InputTypeColorEnhancementsEnabled, CEReactions=NotNeeded, Reflect] attribute boolean alpha;
    [CEReactions=NotNeeded, Reflect] attribute DOMString alt;
    [CEReactions=NotNeeded, ReflectSetter] attribute [AtomString] DOMString autocomplete;
    [CEReactions=NotNeeded, Reflect="checked"] attribute boolean defaultChecked;
    attribute boolean checked;
    [EnabledBySetting=InputTypeColorEnhancementsEnabled, CEReactions=NotNeeded] attribute [AtomString] DOMString colorSpace;
    [CEReactions=NotNeeded, Reflect] attribute DOMString dirName;
    [CEReactions=NotNeeded, Reflect] attribute boolean disabled;
    [ImplementedAs=formForBindings] readonly attribute HTMLFormElement? form;
    [ImplementedAs=filesForBindings] attribute FileList? files;
    [CEReactions=NotNeeded, ReflectSetter] attribute [AtomString] USVString formAction;

    [CEReactions=NotNeeded, ReflectSetter] attribute [AtomString] DOMString formEnctype;
    [CEReactions=NotNeeded, ReflectSetter] attribute [AtomString] DOMString formMethod;

    [CEReactions=NotNeeded, Reflect] attribute boolean formNoValidate;
    [CEReactions=NotNeeded, Reflect] attribute DOMString formTarget;
    [CEReactions=NotNeeded, ReflectSetter] attribute unsigned long height;
    attribute boolean indeterminate;
    readonly attribute HTMLElement? list;
    [CEReactions=NotNeeded, Reflect] attribute DOMString max;
    [CEReactions=NotNeeded] attribute long minLength;
    [CEReactions=NotNeeded] attribute long maxLength;
    [CEReactions=NotNeeded, Reflect] attribute DOMString min;
    [CEReactions=NotNeeded, Reflect] attribute boolean multiple;
    [CEReactions=NotNeeded, Reflect] attribute DOMString name;
    [CEReactions=NotNeeded, Reflect] attribute DOMString pattern;
    [CEReactions=NotNeeded, Reflect] attribute DOMString placeholder;
    [CEReactions=NotNeeded, Reflect] attribute boolean readOnly;
    [CEReactions=NotNeeded, Reflect] attribute boolean required;
    [CEReactions=NotNeeded] attribute unsigned long size;
    [CEReactions=NotNeeded, ReflectURL] attribute USVString src;
    [CEReactions=NotNeeded, Reflect] attribute DOMString step;
    [EnabledBySetting=SwitchControlEnabled, CEReactions=NotNeeded, Reflect] attribute boolean switch;
    [CEReactions=NotNeeded, ReflectSetter] attribute [AtomString] DOMString type;
    [CEReactions=NotNeeded, Reflect="value"] attribute DOMString defaultValue;
    // See the discussion in https://bugs.webkit.org/show_bug.cgi?id=100085
    [CEReactions=NotNeeded] attribute [LegacyNullToEmptyString] DOMString value;
    attribute Date? valueAsDate;
    attribute unrestricted double valueAsNumber;
    [CEReactions=NotNeeded, ReflectSetter] attribute unsigned long width;

    undefined stepUp(optional long n = 1);
    undefined stepDown(optional long n = 1);

    readonly attribute boolean willValidate;
    readonly attribute ValidityState validity;
    readonly attribute DOMString validationMessage;
    boolean checkValidity();
    [EnabledBySetting=InteractiveFormValidationEnabled] boolean reportValidity();
    undefined setCustomValidity(DOMString error);

    readonly attribute NodeList? labels;

    undefined select();
    [ImplementedAs=selectionStartForBindings] attribute unsigned long? selectionStart;
    [ImplementedAs=selectionEndForBindings] attribute unsigned long? selectionEnd;
    [ImplementedAs=selectionDirectionForBindings] attribute DOMString? selectionDirection;

    undefined setRangeText(DOMString replacement);
    undefined setRangeText(DOMString replacement, unsigned long start, unsigned long end, optional DOMString selectionMode);

    [ImplementedAs=setSelectionRangeForBindings] undefined setSelectionRange(unsigned long start, unsigned long end, optional DOMString direction);

    undefined showPicker();

    [CEReactions=NotNeeded, Reflect] attribute DOMString align;
    [CEReactions=NotNeeded, Reflect] attribute DOMString useMap;

    // WebKit extension for autofill.
    [EnabledForWorld=allowAutofill] attribute boolean autofillAvailable;
    [EnabledForWorld=allowAutofill] attribute boolean autofilled;
    [EnabledForWorld=allowAutofill] readonly attribute boolean lastChangeWasUserEdit;
    [EnabledForWorld=allowAutofill] attribute AutofillVisibility autofillVisibility;
    [EnabledForWorld=allowAutofill] attribute AutofillButtonType autofillButtonType;
    [EnabledForWorld=allowAutofill] attribute boolean autofillSpellcheck;
    [EnabledForWorld=allowAutofill] attribute boolean autofilledAndObscured;
    [EnabledForWorld=allowAutofill] attribute boolean autofilledAndViewable;

    // See http://www.w3.org/TR/html-media-capture/
    [CEReactions=NotNeeded, Conditional=MEDIA_CAPTURE, Reflect] attribute DOMString capture;
};

HTMLInputElement includes PopoverInvokerElement;