:right-sidebar: True

DrawingArea
===================================================================

.. currentmodule:: gi.repository.Gtk





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


Superclasses: :class:`~gi.repository.Gtk.Widget`, :class:`~gi.repository.GObject.InitiallyUnowned`, :class:`~gi.repository.GObject.Object`



Implemented Interfaces: :class:`~gi.repository.Gtk.Accessible`, :class:`~gi.repository.Gtk.Buildable`, :class:`~gi.repository.Gtk.ConstraintTarget`



:Constructors:

::

    DrawingArea(**properties)
    new() -> Gtk.Widget



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

.. rst-class:: interim-class

.. class:: DrawingArea
   :no-index:


   .. classmethod:: new() -> ~gi.repository.Gtk.Widget

      Creates a new drawing area.














Methods
-------

.. rst-class:: interim-class

.. class:: DrawingArea
   :no-index:


   .. method:: get_content_height() -> int

      Retrieves the content height of the ``GtkDrawingArea``.










   .. method:: get_content_width() -> int

      Retrieves the content width of the ``GtkDrawingArea``.










   .. method:: set_content_height(height: int) -> None

      Sets the desired height of the contents of the drawing area.

      Note that because widgets may be allocated larger sizes than they
      requested, it is possible that the actual height passed to your draw
      function is larger than the height set here. You can use
      :obj:`~gi.repository.Gtk.Widget.set_valign` to avoid that.

      If the height is set to 0 (the default), the drawing area may disappear.







      :param height: the height of contents





   .. method:: set_content_width(width: int) -> None

      Sets the desired width of the contents of the drawing area.

      Note that because widgets may be allocated larger sizes than they
      requested, it is possible that the actual width passed to your draw
      function is larger than the width set here. You can use
      :obj:`~gi.repository.Gtk.Widget.set_halign` to avoid that.

      If the width is set to 0 (the default), the drawing area may disappear.







      :param width: the width of contents





   .. method:: set_draw_func(draw_func: ~typing.Callable[[...], None] | None = None, *user_data: ~typing.Any) -> None

      Setting a draw function is the main thing you want to do when using
      a drawing area.

      The draw function is called whenever GTK needs to draw the contents
      of the drawing area to the screen.

      The draw function will be called during the drawing stage of GTK.
      In the drawing stage it is not allowed to change properties of any
      GTK widgets or call any functions that would cause any properties
      to be changed. You should restrict yourself exclusively to drawing
      your contents in the draw function.

      If what you are drawing does change, call :obj:`~gi.repository.Gtk.Widget.queue_draw`
      on the drawing area. This will cause a redraw and will call ``draw_func`` again.







      :param draw_func: callback that lets you draw
         the drawing area's contents


      :param user_data: user data passed to ``draw_func``









Properties
----------

.. rst-class:: interim-class

.. class:: DrawingArea
   :no-index:
   

   .. attribute:: props.content_height
      :type: int

      The content height.







   .. attribute:: props.content_width
      :type: int

      The content width.











Signals
-------

.. rst-class:: interim-class

.. class:: DrawingArea.signals
   :no-index:
   

   .. method:: resize(width: int, height: int) -> None

      Emitted once when the widget is realized, and then each time the widget
      is changed while realized.

      This is useful in order to keep state up to date with the widget size,
      like for instance a backing surface.







      :param width: the width of the viewport


      :param height: the height of the viewport









Virtual Methods
---------------

.. rst-class:: interim-class

.. class:: DrawingArea
   :no-index:
   

   .. method:: do_resize(width: int, height: int) -> None

      






      :param width: 

      :param height: 








Fields
------

.. rst-class:: interim-class

.. class:: DrawingArea
   :no-index:
   

   .. attribute:: widget