:right-sidebar: True

TextMark
===================================================================

.. currentmodule:: gi.repository.Gtk





.. class:: TextMark(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GObject.Object`





:Constructors:

::

    TextMark(**properties)
    new(name:str=None, left_gravity:bool) -> Gtk.TextMark



Constructors
------------

.. rst-class:: interim-class

.. class:: TextMark
   :no-index:


   .. classmethod:: new(name: str | None, left_gravity: bool) -> ~gi.repository.Gtk.TextMark

      Creates a text mark.

      Add it to a buffer using :obj:`~gi.repository.Gtk.TextBuffer.add_mark`.
      If ``name`` is :const:`None`, the mark is anonymous; otherwise, the mark can be
      retrieved by name using :obj:`~gi.repository.Gtk.TextBuffer.get_mark`. If a mark
      has left gravity, and text is inserted at the mark’s current location,
      the mark will be moved to the left of the newly-inserted text. If the
      mark has right gravity (``left_gravity`` = :const:`False`), the mark will end up
      on the right of newly-inserted text. The standard left-to-right cursor
      is a mark with right gravity (when you type, the cursor stays on the
      right side of the text you’re typing).







      :param name: mark name


      :param left_gravity: whether the mark should have left gravity









Methods
-------

.. rst-class:: interim-class

.. class:: TextMark
   :no-index:


   .. method:: get_buffer() -> ~gi.repository.Gtk.TextBuffer | None

      Gets the buffer this mark is located inside.

      Returns :const:`None` if the mark is deleted.










   .. method:: get_deleted() -> bool

      Returns :const:`True` if the mark has been removed from its buffer.

      See :obj:`~gi.repository.Gtk.TextBuffer.add_mark` for a way to add it
      to a buffer again.










   .. method:: get_left_gravity() -> bool

      Determines whether the mark has left gravity.










   .. method:: get_name() -> str | None

      Returns the mark name.

      Returns :const:`None` for anonymous marks.










   .. method:: get_visible() -> bool

      Returns :const:`True` if the mark is visible.

      A cursor is displayed for visible marks.










   .. method:: set_visible(setting: bool) -> None

      






      :param setting: 








Properties
----------

.. rst-class:: interim-class

.. class:: TextMark
   :no-index:
   

   .. attribute:: props.left_gravity
      :type: bool

      Whether the mark has left gravity.

      When text is inserted at the mark’s current location, if the mark
      has left gravity it will be moved to the left of the newly-inserted
      text, otherwise to the right.







   .. attribute:: props.name
      :type: str

      The name of the mark or :const:`None` if the mark is anonymous.















Fields
------

.. rst-class:: interim-class

.. class:: TextMark
   :no-index:
   

   .. attribute:: parent_instance

      






   .. attribute:: segment