~george-edison55/twistload/trunk

« back to all changes in this revision

Viewing changes to src/fs/file.h

  • Committer: Nathan Osman
  • Date: 2017-07-20 19:01:04 UTC
  • Revision ID: git-v1:f6404b4fb7bc534c1c108af8860fb8f7593f0b69
Add a couple of methods to File class.

Show diffs side-by-side

added added

removed removed

Lines of Context:
46
46
 
47
47
    /**
48
48
     * @brief Create a new file
 
49
     *
 
50
     * The filename must be set with setFilename().
 
51
     */
 
52
    File();
 
53
 
 
54
    /**
 
55
     * @brief Create a new file
49
56
     */
50
57
    explicit File(const QString &filename);
51
58
 
58
65
    virtual ~File();
59
66
 
60
67
    /**
 
68
     * @brief Retrieve the filename
 
69
     */
 
70
    QString filename() const;
 
71
 
 
72
    /**
 
73
     * @brief Set the filename
 
74
     */
 
75
    void setFilename(const QString &filename);
 
76
 
 
77
    /**
61
78
     * @brief Open the file for writing
62
79
     *
63
80
     * This method opens the file for writing and ensures that if size is
79
96
Q_SIGNALS:
80
97
 
81
98
    /**
 
99
     * @brief Indicate an error occurred during allocation or writing
 
100
     */
 
101
    void error(const QString &message);
 
102
 
 
103
    /**
82
104
     * @brief Indicate allocation progress
83
105
     * @param value integer between 0 and 100 inclusive
84
106
     */
85
107
    void allocationProgress(int value);
86
108
 
87
109
    /**
88
 
     * @brief Indicate an error occurred during allocation or writing
89
 
     */
90
 
    void allocationError(const QString &message);
91
 
 
92
 
    /**
93
110
     * @brief Indicate that the file has successfully been allocated
94
111
     *
95
112
     * The file will be open for writing.