// Generated by gmmproc 2.86.0 -- DO NOT MODIFY!
#ifndef _PANGOMM_TABARRAY_H
#define _PANGOMM_TABARRAY_H


#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>

/* tabarray.h
 *
 * Copyright (C) 1998-1999 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, see <https://www.gnu.org/licenses/>.
 */

#include <pangomm/attrlist.h>
#include <pango/pango.h>
#include <utility>


#ifndef DOXYGEN_SHOULD_SKIP_THIS
extern "C" { typedef struct _PangoTabArray PangoTabArray; }
#endif

namespace Pango
{

/** @addtogroup pangommEnums pangomm Enums and Flags */

/** 
 *  @var TabAlign::LEFT
 * The text appears to the right of the tab stop position.
 * 
 *  @var TabAlign::RIGHT
 * The text appears to the left of the tab stop position
 * until the available space is filled. @newin{1,50}
 * 
 *  @var TabAlign::CENTER
 * The text is centered at the tab stop position
 * until the available space is filled. @newin{1,50}
 * 
 *  @var TabAlign::DECIMAL
 * Text before the first occurrence of the decimal point
 * character appears to the left of the tab stop position (until the available
 * space is filled), the rest to the right. @newin{1,50}
 */
 /** `Pango::TabAlign` specifies where the text appears relative to the tab stop
 * position.
 *
 * @ingroup pangommEnums
 */
enum class TabAlign
{
  LEFT,
  RIGHT,
  CENTER,
  DECIMAL
};


} // namespace Pango

#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{

template <>
class PANGOMM_API Value<Pango::TabAlign> : public Glib::Value_Enum<Pango::TabAlign>
{
public:
  static GType value_type() G_GNUC_CONST;
};

} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

namespace Pango
{


/** A %Pango::TabArray contains an array of tab stops.
 * Each tab stop has an alignment and a position.
 */
class PANGOMM_API TabArray
{
  public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  using CppObjectType = TabArray;
  using BaseObjectType = PangoTabArray;
#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;

  TabArray();

  explicit TabArray(PangoTabArray* gobject, bool make_a_copy = true);

  TabArray(const TabArray& other);
  TabArray& operator=(const TabArray& other);

  TabArray(TabArray&& other) noexcept;
  TabArray& operator=(TabArray&& other) noexcept;

  ~TabArray() noexcept;

  void swap(TabArray& other) noexcept;

  ///Provides access to the underlying C instance.
  PangoTabArray*       gobj()       { return gobject_; }

  ///Provides access to the underlying C instance.
  const PangoTabArray* 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.
  PangoTabArray* gobj_copy() const;

protected:
  PangoTabArray* gobject_;

private:

  
public:
  explicit TabArray(int initial_size, bool positions_in_pixels = true);

  /** Deserializes a %Pango::TabArray from a string.
   *
   * This is the counterpart to to_string().
   * See that function for details about the format.
   *
   * @newin{2,54}
   *
   * @param text A string.
   * @return A new %Pango::TabArray.
   */
  explicit TabArray(const Glib::ustring& text);
  

  /** Checks whether this %TabArray is valid.
   *
   * @newin{2,54}
   *
   * @return <tt>true</tt> if the %TabArray is valid.
   */
  explicit operator bool() const;

  
  /** Gets the number of tab stops in @a tab_array.
   * 
   * @return The number of tab stops in the array.
   */
  int get_size() const;
  
  /** Resizes a tab array.
   * 
   * You must subsequently initialize any tabs
   * that were added as a result of growing the array.
   * 
   * @param new_size New size of the array.
   */
  void resize(int new_size);
  
  /** Sets the alignment and location of a tab stop.
   * 
   * @param tab_index The index of a tab stop.
   * @param alignment Tab alignment.
   * @param location Tab location in Pango units.
   */
  void set_tab(int tab_index, TabAlign alignment, int location);

  /** Gets the alignment and position of a tab stop.
   * @return An std::pair<TabAlign, int>. The first element represents the tab stop alignment, the second one is the tab position.
   */
  std::pair<TabAlign, int> get_tab(int tab_index) const;

  /** Gets an array of std::pairs containing the tab stop alignments and tab positions.
   * @return An array of std::pair<TabAlign, int>. The first element in each pair represents the tab stop alignment, the second one is the tab position.
   */
  std::vector<std::pair<TabAlign, int>> get_tabs() const;

  
  /** Returns <tt>true</tt> if the tab positions are in pixels,
   * <tt>false</tt> if they are in Pango units.
   * 
   * @return Whether positions are in pixels.
   */
  bool get_positions_in_pixels() const;
  
  /** Sets whether positions in this array are specified in
   * pixels.
   * 
   * @newin{2,54}
   * 
   * @param positions_in_pixels Whether positions are in pixels.
   */
  void set_positions_in_pixels(bool positions_in_pixels =  true);
  
  /** Serializes a `Pango::TabArray` to a string.
   * 
   * In the resulting string, serialized tabs are separated by newlines or commas.
   * 
   * Individual tabs are serialized to a string of the form
   * 
   * [ALIGNMENT:]POSITION[:DECIMAL_POINT]
   * 
   * Where ALIGNMENT is one of _left_, _right_, _center_ or _decimal_, and
   * POSITION is the position of the tab, optionally followed by the unit _px_.
   * If ALIGNMENT is omitted, it defaults to _left_. If ALIGNMENT is _decimal_,
   * the DECIMAL_POINT character may be specified as a Unicode codepoint.
   * 
   * Note that all tabs in the array must use the same unit.
   * 
   * A typical example:
   * 
   * 100px 200px center:300px right:400px
   * 
   * 
   * @newin{2,54}
   * 
   * @return A newly allocated string.
   */
  Glib::ustring to_string() const;
  
  /** Sets the Unicode character to use as decimal point.
   * 
   * This is only relevant for tabs with Pango::TabAlign::DECIMAL alignment,
   * which align content at the first occurrence of the decimal point
   * character.
   * 
   * By default, Pango uses the decimal point according
   * to the current locale.
   * 
   * @newin{2,54}
   * 
   * @param tab_index The index of a tab stop.
   * @param decimal_point The decimal point to use.
   */
  void set_decimal_point(int tab_index, gunichar decimal_point);
  
  /** Gets the Unicode character to use as decimal point.
   * 
   * This is only relevant for tabs with Pango::TabAlign::DECIMAL alignment,
   * which align content at the first occurrence of the decimal point
   * character.
   * 
   * The default value of 0 means that Pango will use the
   * decimal point according to the current locale.
   * 
   * @newin{2,54}
   * 
   * @param tab_index The index of a tab stop.
   */
  gunichar get_decimal_point(int tab_index) const;
  
  /** Utility function to ensure that the tab stops are in increasing order.
   * 
   * @newin{2,54}
   */
  void sort();


};

} //namespace Pango


namespace Pango
{

/** @relates Pango::TabArray
 * @param lhs The left-hand side
 * @param rhs The right-hand side
 */
inline void swap(TabArray& lhs, TabArray& 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::TabArray
 */
PANGOMM_API
Pango::TabArray wrap(PangoTabArray* object, bool take_copy = false);

#ifndef DOXYGEN_SHOULD_SKIP_THIS
template <>
class PANGOMM_API Value<Pango::TabArray> : public Glib::Value_Boxed<Pango::TabArray>
{};
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

} // namespace Glib


#endif /* _PANGOMM_TABARRAY_H */

