Source/WebCore/page/Location.idl

/*
 * Copyright (C) 2008 Apple Inc.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer. 
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution. 
 * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission. 
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

[
    JSCustomGetOwnPropertySlotAndDescriptor,
    CustomNamedSetter,
    GenerateIsReachable=ImplFrame,
    CustomDeleteProperty,
    CustomEnumerateProperty,
    JSCustomDefineOwnProperty,
    JSCustomNamedGetterOnPrototype,
    JSCustomDefineOwnPropertyOnPrototype,
    Unforgeable
] interface Location {
    [SetterCallWith=ActiveWindow&FirstWindow] attribute DOMString href;

    [CallWith=ActiveWindow&FirstWindow, ForwardDeclareInHeader] void assign(DOMString url);
    [CallWith=ActiveWindow&FirstWindow, ForwardDeclareInHeader] void replace(DOMString url);
    [CallWith=ActiveWindow, ForwardDeclareInHeader] void reload();

    // URI decomposition attributes
    [SetterCallWith=ActiveWindow&FirstWindow, SetterRaisesException] attribute DOMString protocol;
    [SetterCallWith=ActiveWindow&FirstWindow] attribute DOMString host;
    [SetterCallWith=ActiveWindow&FirstWindow] attribute DOMString hostname;
    [SetterCallWith=ActiveWindow&FirstWindow] attribute DOMString port;
    [SetterCallWith=ActiveWindow&FirstWindow] attribute DOMString pathname;
    [SetterCallWith=ActiveWindow&FirstWindow] attribute DOMString search;
    [SetterCallWith=ActiveWindow&FirstWindow] attribute DOMString hash;

    readonly attribute DOMString origin;

    readonly attribute DOMStringList ancestorOrigins;

#if defined(LANGUAGE_JAVASCRIPT) && LANGUAGE_JAVASCRIPT
    [NotEnumerable, Custom, ImplementedAs=toStringFunction] DOMString toString();
#endif
};