trustpoint.page_context
=======================

.. py:module:: trustpoint.page_context

.. autoapi-nested-parse::

   This module contains page category objects providing the corresponding subcategories.



Attributes
----------

.. autoapisummary::

   trustpoint.page_context.DEVICES_PAGE_CATEGORY
   trustpoint.page_context.DEVICES_PAGE_DEVICES_SUBCATEGORY
   trustpoint.page_context.DEVICES_PAGE_OPC_UA_SUBCATEGORY


Classes
-------

.. autoapisummary::

   trustpoint.page_context.PageContextMixin


Module Contents
---------------

.. py:data:: DEVICES_PAGE_CATEGORY
   :value: 'devices'


.. py:data:: DEVICES_PAGE_DEVICES_SUBCATEGORY
   :value: 'devices'


.. py:data:: DEVICES_PAGE_OPC_UA_SUBCATEGORY
   :value: 'opc_ua_gds'


.. py:class:: PageContextMixin

   Mixin which adds data to the context for the devices application.


   .. py:attribute:: page_category
      :type:  str | None
      :value: None



   .. py:attribute:: page_name
      :type:  str | None
      :value: None



   .. py:method:: get_context_data(**kwargs)

      Adds the page category and page_name for the device pages.

      :param kwargs: The keyword arguments are passed to super().get_context_data() if it exists.
                     Otherwise, kwargs is returned with the added page_category.

      :returns: The context data including the page_category information.