:right-sidebar: True

FileChooserRequest
===================================================================

.. currentmodule:: gi.repository.WebKit





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


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





A request to open a file chooser.

Whenever the user interacts with an HTML input element with
file type, WebKit will need to show a dialog to choose one or
more files to be uploaded to the server along with the rest of the
form data. For that to happen in a general way, instead of just
opening a ``GtkFileChooserDialog`` (which might be not desirable in
some cases, which could prefer to use their own file chooser
dialog), WebKit will fire the :obj:`~gi.repository.WebKit.WebView`\::run-file-chooser
signal with a :obj:`~gi.repository.WebKit.FileChooserRequest` object, which will allow
the client application to specify the files to be selected, to
inspect the details of the request (e.g. if multiple selection
should be allowed) and to cancel the request, in case nothing was
selected.

In case the client application does not wish to handle this signal,
WebKit will provide a default handler which will asynchronously run
a regular ``GtkFileChooserDialog`` for the user to interact with.




Methods
-------

.. rst-class:: interim-class

.. class:: FileChooserRequest
   :no-index:


   .. method:: cancel() -> None

      Ask WebKit to cancel the request.

      It's important to do this in case
      no selection has been made in the client, otherwise the request
      won't be properly completed and the browser will keep the request
      pending forever, which might cause the browser to hang.









   .. method:: get_mime_types() -> list[str]

      Get the list of MIME types the file chooser dialog should handle.

      Get the list of MIME types the file chooser dialog should handle,
      in the format specified in RFC 2046 for "media types". Its contents
      depend on the value of the 'accept' attribute for HTML input
      elements. This function should normally be called before presenting
      the file chooser dialog to the user, to decide whether to allow the
      user to select multiple files at once or only one.









   .. method:: get_mime_types_filter() -> ~gi.repository.Gtk.FileFilter

      Get the filter currently associated with the request.

      Get the filter currently associated with the request, ready to be
      used by :obj:`~gi.repository.Gtk.FileChooser`\. This function should normally be called
      before presenting the file chooser dialog to the user, to decide
      whether to apply a filter so the user would not be allowed to
      select files with other MIME types.

      See :func:`~gi.repository.WebKit.FileChooserRequest.get_mime_types` if you are
      interested in getting the list of accepted MIME types.









   .. method:: get_select_multiple() -> bool

      Whether the file chooser should allow selecting multiple files.

      Determine whether the file chooser associated to this
      :obj:`~gi.repository.WebKit.FileChooserRequest` should allow selecting multiple files,
      which depends on the HTML input element having a 'multiple'
      attribute defined.









   .. method:: get_selected_files() -> list[str]

      Get the list of selected files associated to the request.

      Get the list of selected files currently associated to the
      request. Initially, the return value of this method contains any
      files selected in previous file chooser requests for this HTML
      input element. Once webkit_file_chooser_request_select_files, the
      value will reflect whatever files are given.

      This function should normally be called only before presenting the
      file chooser dialog to the user, to decide whether to perform some
      extra action, like pre-selecting the files from a previous request.









   .. method:: select_files(files: list[str]) -> None

      Ask WebKit to select local files for upload and complete the
      request.






      :param files: a
         :const:`None`-terminated array of strings, containing paths to local files.








Properties
----------

.. rst-class:: interim-class

.. class:: FileChooserRequest
   :no-index:
   

   .. attribute:: props.filter
      :type: ~gi.repository.Gtk.FileFilter

      The type of the None singleton.







   .. attribute:: props.mime_types
      :type: list[str]

      The type of the None singleton.







   .. attribute:: props.select_multiple
      :type: bool

      The type of the None singleton.







   .. attribute:: props.selected_files
      :type: list[str]

      The type of the None singleton.