// Generated by gmmproc 2.49.5 -- DO NOT MODIFY! #ifndef _PANGOMM_LAYOUTITER_H #define _PANGOMM_LAYOUTITER_H #include #include /* $Id: layoutiter.hg,v 1.2 2003/12/14 11:54:05 murrayc Exp $ */ /* layoutiter.h * * Copyright 2001-2002 The gtkmm Development Team * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 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 * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ #include #include #include #ifndef DOXYGEN_SHOULD_SKIP_THIS extern "C" { typedef struct _PangoLayoutIter PangoLayoutIter; } #endif namespace Pango { /** A Pango::LayoutIter can be used to iterate over the visual extents of a Pango::Layout. */ class LayoutIter { public: #ifndef DOXYGEN_SHOULD_SKIP_THIS using CppObjectType = LayoutIter; using BaseObjectType = PangoLayoutIter; #endif /* DOXYGEN_SHOULD_SKIP_THIS */ /** Get the GType for this class, for use with the underlying GObject type system. */ static GType get_type() G_GNUC_CONST; LayoutIter(); explicit LayoutIter(PangoLayoutIter* gobject, bool make_a_copy = true); LayoutIter(const LayoutIter& other); LayoutIter& operator=(const LayoutIter& other); LayoutIter(LayoutIter&& other) noexcept; LayoutIter& operator=(LayoutIter&& other) noexcept; ~LayoutIter() noexcept; void swap(LayoutIter& other) noexcept; ///Provides access to the underlying C instance. PangoLayoutIter* gobj() { return gobject_; } ///Provides access to the underlying C instance. const PangoLayoutIter* gobj() const { return gobject_; } ///Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs. PangoLayoutIter* gobj_copy() const; protected: PangoLayoutIter* gobject_; private: public: /** Gets the current byte index. Note that iterating forward by char * moves in visual order, not logical order, so indexes may not be * sequential. Also, the index may be equal to the length of the text * in the layout, if on the nullptr run (see get_run()). * * @return Current byte index. */ int get_index() const; /** Gets the current run. When iterating by run, at the end of each * line, there's a position with a nullptr run, so this function can return * nullptr. The nullptr run at the end of each line ensures that all lines have * at least one run, even lines consisting of only a newline. * * Use the faster get_run_readonly() if you do not plan * to modify the contents of the run (glyphs, glyph widths, etc.). * * @return The current run. */ LayoutRun get_run() const; //TODO: Use pango_layout_iter_get_run_readonly()? /** Gets the current line. * * Use the faster get_line_readonly() if you do not plan * to modify the contents of the line (glyphs, glyph widths, etc.). * * @return The current line. */ Glib::RefPtr get_line() const; //TODO: We should really have a const and non-const version: _WRAP_METHOD(Glib::RefPtr get_line() const, pango_layout_iter_get_line_readonly, refreturn) /** Determines whether @a iter is on the last line of the layout. * * @return true if @a iter is on the last line. */ bool at_last_line() const; /** Gets the layout associated with a Pango::LayoutIter. * * @newin{1,20} * * @return The layout associated with @a iter. */ Glib::RefPtr get_layout(); /** Gets the layout associated with a Pango::LayoutIter. * * @newin{1,20} * * @return The layout associated with @a iter. */ Glib::RefPtr get_layout() const; /** Moves @a iter forward to the next character in visual order. If @a iter was already at * the end of the layout, returns false. * * @return Whether motion was possible. */ bool next_char(); /** Moves @a iter forward to the next cluster in visual order. If @a iter * was already at the end of the layout, returns false. * * @return Whether motion was possible. */ bool next_cluster(); /** Moves @a iter forward to the next run in visual order. If @a iter was * already at the end of the layout, returns false. * * @return Whether motion was possible. */ bool next_run(); /** Moves @a iter forward to the start of the next line. If @a iter is * already on the last line, returns false. * * @return Whether motion was possible. */ bool next_line(); /** Gets the extents of the current character, in layout coordinates (origin is the top left of the entire layout). * Only logical extents can sensibly be obtained for characters; ink extents make sense only down to the level of clusters. * @return The logical extents of the current character. */ Rectangle get_char_extents() const; /** Gets the extents of the current cluster, in layout coordinates * (origin is the top left of the entire layout). * * @param ink_rect Rectangle to fill with ink extents, or nullptr. * @param logical_rect Rectangle to fill with logical extents, or nullptr. */ void get_cluster_extents(Rectangle& ink_rect, Rectangle& logical_rect) const; /** Gets the ink extents of the current cluster, in layout coordinates (origin is the top left of the entire layout). * @return The extents of the current cluster as drawn. */ Rectangle get_cluster_ink_extents() const; /** Gets the logical extents of the current cluster, in layout coordinates (origin is the top left of the entire layout). * @return The logical extents of the current cluster. */ Rectangle get_cluster_logical_extents() const; /** Gets the extents of the current run in layout coordinates * (origin is the top left of the entire layout). * * @param ink_rect Rectangle to fill with ink extents, or nullptr. * @param logical_rect Rectangle to fill with logical extents, or nullptr. */ void get_run_extents(Rectangle& ink_rect, Rectangle& logical_rect) const; /** Gets the ink extents of the current run in layout coordinates (origin is the top left of the entire layout). * @return The extents of the current run as drawn. */ Rectangle get_run_ink_extents() const; /** Gets the logical extents of the current run in layout coordinates (origin is the top left of the entire layout). * @return The logical extents of the current run. */ Rectangle get_run_logical_extents() const; /** Obtains the extents of the current line. @a ink_rect or @a logical_rect * can be nullptr if you aren't interested in them. Extents are in layout * coordinates (origin is the top-left corner of the entire * Pango::Layout). Thus the extents returned by this function will be * the same width/height but not at the same x/y as the extents * returned from Pango::LayoutLine::get_extents(). * * @param ink_rect Rectangle to fill with ink extents, or nullptr. * @param logical_rect Rectangle to fill with logical extents, or nullptr. */ void get_line_extents(Rectangle& ink_rect, Rectangle& logical_rect) const; /** Obtains the ink extents of the current line. * @return The extents of the current line as drawn. */ Rectangle get_line_ink_extents() const; /** Obtains the logical extents of the current line. * @return The logical extents of the current line. */ Rectangle get_line_logical_extents() const; /** Divides the vertical space in the Pango::Layout being iterated over * between the lines in the layout, and returns the space belonging to * the current line. A line's range includes the line's logical * extents, plus half of the spacing above and below the line, if * set_spacing() has been called to set layout spacing. * The Y positions are in layout coordinates (origin at top left of the * entire layout). * * @param y0 Start of line, or nullptr. * @param y1 End of line, or nullptr. */ void get_line_yrange(int& y0, int& y1) const; /** Obtains the extents of the Pango::Layout being iterated * over. @a ink_rect or @a logical_rect can be nullptr if you * aren't interested in them. * * @param ink_rect Rectangle to fill with ink extents, * or nullptr. * @param logical_rect Rectangle to fill with logical * extents, or nullptr. */ void get_layout_extents(Rectangle& ink_rect, Rectangle& logical_rect) const; /** Obtains the ink extents of the Pango::Layout being iterated over. * @return The extents of the layout as drawn. */ Rectangle get_layout_ink_extents() const; /** Obtains the logical extents of the Pango::Layout being iterated over. * @return The logical extents of the layout. */ Rectangle get_layout_logical_extents() const; /** Gets the Y position of the current line's baseline, in layout * coordinates (origin at top left of the entire layout). * * @return Baseline of current line. */ int get_baseline() const; #ifndef DOXYGEN_SHOULD_SKIP_THIS /** @deprecated Use the copy constructor instead. * This was only ever for internal use anyway. */ void assign_gobj(PangoLayoutIter* src); #endif }; } //namespace Pango namespace Pango { /** @relates Pango::LayoutIter * @param lhs The left-hand side * @param rhs The right-hand side */ inline void swap(LayoutIter& lhs, LayoutIter& rhs) noexcept { lhs.swap(rhs); } } // namespace Pango namespace Glib { /** A Glib::wrap() method for this object. * * @param object The C instance. * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref. * @result A C++ instance that wraps this C instance. * * @relates Pango::LayoutIter */ Pango::LayoutIter wrap(PangoLayoutIter* object, bool take_copy = false); #ifndef DOXYGEN_SHOULD_SKIP_THIS template <> class Value : public Glib::Value_Boxed {}; #endif /* DOXYGEN_SHOULD_SKIP_THIS */ } // namespace Glib #endif /* _PANGOMM_LAYOUTITER_H */