WebCore/page/FrameLoadRequest.h

/*
 * Copyright (C) 2003, 2006 Apple Computer, 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.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``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 COMPUTER, INC. OR
 * 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. 
 */

#ifndef FrameLoadRequest_h
#define FrameLoadRequest_h

#include "ResourceRequest.h"

namespace WebCore {

    struct FrameLoadRequest {
    public:
        FrameLoadRequest()
            : m_lockHistory(false)
#ifdef ANDROID_USER_GESTURE
            , m_wasUserGesture(true)
#endif
        {
        }

        FrameLoadRequest(const ResourceRequest& resourceRequest)
            : m_resourceRequest(resourceRequest)
            , m_lockHistory(false)
#ifdef ANDROID_USER_GESTURE
            , m_wasUserGesture(true)
#endif
        {
        }

        FrameLoadRequest(const ResourceRequest& resourceRequest, const String& frameName)
            : m_resourceRequest(resourceRequest)
            , m_frameName(frameName)
            , m_lockHistory(false)
#ifdef ANDROID_USER_GESTURE
            , m_wasUserGesture(true)
#endif
        {
        }

        bool isEmpty() const { return m_resourceRequest.isEmpty(); }

        ResourceRequest& resourceRequest() { return m_resourceRequest; }
        const ResourceRequest& resourceRequest() const { return m_resourceRequest; }

        const String& frameName() const { return m_frameName; }
        void setFrameName(const String& frameName) { m_frameName = frameName; }

        bool lockHistory() const { return m_lockHistory; }
        void setLockHistory(bool lock) { m_lockHistory = lock; }

#ifdef ANDROID_USER_GESTURE
        void setWasUserGesture(bool wasUserGesture) { m_wasUserGesture = wasUserGesture; }
        bool wasUserGesture() const { return m_wasUserGesture; }
#endif

    private:
        ResourceRequest m_resourceRequest;
        String m_frameName;
        bool m_lockHistory;
#ifdef ANDROID_USER_GESTURE
        bool m_wasUserGesture;
#endif
    };

}

#endif // FrameLoadRequest_h