Class to read the header details from a RISC OS Module.
More...
#include <module_info.h>
|
| module_info () |
| Construct an uninitialised module_info object Call the read method to initialise it. More...
|
|
| module_info (const std::string &path) |
| Read module information from given path to module file. More...
|
|
bool | read (const std::string &path) |
| Read module information from given path to module file. More...
|
|
bool | read_ok () const |
| Check if module information has been update successfully. More...
|
|
const std::string & | title () |
| Get the module title. More...
|
|
const std::string & | help_string () |
| Get module help string. More...
|
|
std::string | version () const |
| Get the module version. More...
|
|
Class to read the header details from a RISC OS Module.
pkg::module_info::module_info |
( |
| ) |
|
|
inline |
Construct an uninitialised module_info object Call the read method to initialise it.
pkg::module_info::module_info |
( |
const std::string & |
path | ) |
|
Read module information from given path to module file.
Check read_ok() method to see if read succeeded
- Parameters
-
path | full path to the module to read information from |
References read().
bool pkg::module_info::read |
( |
const std::string & |
path | ) |
|
Read module information from given path to module file.
Sets the value returned by read_ok() method
- Parameters
-
path | full path to the module to read information from |
- Returns
- true if read succeeded, false otherwise
Referenced by module_info().
bool pkg::module_info::read_ok |
( |
| ) |
const |
|
inline |
Check if module information has been update successfully.
- Returns
- true if module information was updated.
const std::string& pkg::module_info::title |
( |
| ) |
|
|
inline |
Get the module title.
- Returns
- title of the module
const std::string& pkg::module_info::help_string |
( |
| ) |
|
|
inline |
Get module help string.
- Returns
- help string
std::string pkg::module_info::version |
( |
| ) |
const |
|
inline |
Get the module version.
- Returns
- module version as a string (e.g. 1.23)
The documentation for this class was generated from the following files: