Home | History | Annotate | Download | only in web
      1 /*
      2  * Copyright (C) 2012 Google Inc. All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions are
      6  * met:
      7  *
      8  *     * Redistributions of source code must retain the above copyright
      9  * notice, this list of conditions and the following disclaimer.
     10  *     * Redistributions in binary form must reproduce the above
     11  * copyright notice, this list of conditions and the following disclaimer
     12  * in the documentation and/or other materials provided with the
     13  * distribution.
     14  *     * Neither the name of Google Inc. nor the names of its
     15  * contributors may be used to endorse or promote products derived from
     16  * this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 #ifndef FindInPageCoordinates_h
     32 #define FindInPageCoordinates_h
     33 
     34 #include "platform/geometry/FloatRect.h"
     35 
     36 namespace blink {
     37 class Range;
     38 class RenderObject;
     39 
     40 // Find-in-page coordinate conversion methods.
     41 //
     42 // This coordinate system is designed to give consistent tickmarks in cases where find matches
     43 // are in scrollable areas but might not be visible (e.g. child frames, scroll:overflow).
     44 // In these cases, using absolute positions might lead to tickmarks pointing outside the visible
     45 // area of its container, which is counter-intuitive for users.
     46 //
     47 // Find-in-page coordinates are represented as normalized fractions of the main frame document with
     48 // the property that they are built by composing the relative position of each renderer to the maximum
     49 // effective layout size of its container all the way up the render tree. The resulting coordinates
     50 // are scroll-independent, representing any contents scaled to the visible area of their container.
     51 // The provided methods support scroll:overflow and are CSS position and transform-friendly.
     52 
     53 FloatRect findInPageRectFromAbsoluteRect(const FloatRect&, const RenderObject*);
     54 FloatRect findInPageRectFromRange(Range*);
     55 
     56 } // namespace blink
     57 
     58 #endif
     59