Methods

{
  "name": "QMenuFilesRecentlyOpened",
  "namespace": "sofa::qt",
  "module": "sofa.qt.QMenuFilesRecentlyOpened.cpp",
  "include": "sofa/qt/QMenuFilesRecentlyOpened.h",
  "doc": "",
  "inherits": [
    "FilesRecentlyOpenedManager"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "openFile",
      "return_type": "void",
      "params": [
        {
          "name": "file",
          "type": "const int &"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "createWidget",
      "return_type": "QMenu *",
      "params": [
        {
          "name": "parent",
          "type": "QWidget *"
        },
        {
          "name": "",
          "type": "const int &"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "getMenu",
      "return_type": "QMenu *",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "updateWidget",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    }
  ],
  "description": "The `QMenuFilesRecentlyOpened` class in the `sofa::qt` namespace is part of the SOFA framework and provides functionality for managing recently opened files through a graphical user interface (GUI). This component inherits from `FilesRecentlyOpenedManager`. It allows users to access their recently used files via menu options within the GUI. The public methods include `openFile`, which takes an integer parameter representing the file index, `createWidget` that creates and returns a QMenu widget for the parent QWidget, and `getMenu` that retrieves the QMenu instance. Protected method `updateWidget` is used internally to refresh the menu items as needed.",
  "maths": "The `QMenuFilesRecentlyOpened` class is part of the SOFA framework's GUI components and does not contribute directly to any mathematical or physical models within the Finite Element Method (FEM) simulation pipeline. This component is purely related to user interface functionality for managing recently opened files through a menu system, inheriting from `FilesRecentlyOpenedManager`. It provides methods such as `openFile`, `createWidget`, and `getMenu` that are used to interact with a graphical menu widget but does not involve any FEM operators, constitutive laws, or discretization choices. Therefore, there is no mathematical or physical content directly associated with this component in the context of computational mechanics.",
  "abstract": "The `QMenuFilesRecentlyOpened` class manages recently opened files through a graphical menu system in SOFA's GUI, inheriting from `FilesRecentlyOpenedManager`. It provides methods for creating, updating, and accessing the QMenu widget.",
  "sheet": "<p># QMenuFilesRecentlyOpened</p>\n\n<h2>Overview</h2>\n<p>The `QMenuFilesRecentlyOpened` class is part of SOFA's GUI components and manages recently opened files through a graphical menu system. It inherits from `FilesRecentlyOpenedManager`, providing methods for creating, updating, and accessing the QMenu widget.</p>\n\n<h2>Parameters and Data</h2>\n<p>The component does not expose any significant data fields or parameters that control its behavior beyond what is inherited from `FilesRecentlyOpenedManager`.</p>"
}