# -*- coding: utf-8 -*-

# Copyright (c) 2015, Michael Droettboom 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 THE COPYRIGHT HOLDERS AND 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 THE

# COPYRIGHT OWNER 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.

# The views and conclusions contained in the software and

# documentation are those of the authors and should not be interpreted

# as representing official policies, either expressed or implied, of

# the FreeBSD Project.

from __future__ import print_function, unicode_literals, absolute_import

Layout__init__ = """

|freetypy| Manages very simple layout of left-to-right text.

Parameters

----------

face : Face

The face for the layout.

text : unicode

The text to display in the layout.

load_flags : `LOAD` flags, optional

Any glyph load flags

"""

Layout_ink_bbox = """

The tight bounding box (`BBox`) of the physical characters in the

layout. The origin is at (0, 0). The result is in pixels.

"""

Layout_layout_bbox = """

The logical bounding box (`BBox`) of the layout. This should be used

to manage the layout of the text against other text. The result is in

pixels.

"""

Layout_layout = """

Returns a list of tuples describing the layout.

Each tuple is of the form:

- `Face`: The `Face` object containing the glyph

- `glyph_index`: The glyph index within the `Face`

- `(x, y)`: The x, y position of the glyph

"""