• OctoMY API
  • OctoMY API Reference
  • C++ Classes
  • OctoMY
  • HelpListTask
  • help::HelpListTask Class

    class help::HelpListTask

    OpalTask that enumerates pages under a help-tree subfolder. More...

    Header: #include <HelpListTask>
    Inherits: OpalTask

    Detailed Description

    Parameters: - folder (optional, default = root): qrc-relative folder path - recursive (optional, default false): if true, walk the whole subtree

    Outputs: - count: number of pages - pages: JSON array of path,title,depth

    See also HelpTocModel.