← Back to branch summary

~elementary-apps/granite/valadoc

« back to all changes in this revision

Viewing changes to granite/Granite.Application.html

  • Committer: Sergey "Shnatsel" Davidoff
  • Date: 2014-05-08 14:03:25 UTC
  • Revision ID: shnatsel@gmail.com-20140508140325-nlwfgsiygrcpqf1j
Docs for trunk revision 732

Show diffs side-by-side

added added

removed removed

Lines of Context:
granite/Granite.Application.html
66
66
        <img class="main_diagram" usemap="#Granite.Application" alt="Object hierarchy for Application" src="img/Granite.Application.png"/>
67
67
 
68
68
      <map id="Granite.Application" name="Granite.Application">
69
 
<area shape="rect" id="node1" href="Granite.Application.html" title="Granite.Application" alt="" coords="163,293,328,341"/>
 
69
<area shape="rect" id="node1" href="Granite.Application.html" title="Granite.Application" alt="" coords="163,293,329,341"/>
70
70
</map>
71
71
 
72
72
        <h2 class="main_title">Description:</h2>
137
137
            </div></li>
138
138
          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><code>string</code></span> <b><a href="Granite.Application.program_name.html" class="field">program_name</a></b>
139
139
            </span>
140
 
            <div class="leaf_brief_description">
 
140
            <div class="leaf_brief_description"><span class="brief_description">The user facing name of the application. This name is used throughout 
 
141
                the application and should be capitalized correctly.</span>
141
142
            </div></li>
142
143
          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><code>string</code></span> <b><a href="Granite.Application.exec_name.html" class="field">exec_name</a></b>
143
144
            </span>
144
 
            <div class="leaf_brief_description">
 
145
            <div class="leaf_brief_description"><span class="brief_description">The compiled binary name, which must match the CMake exec name. This 
 
146
                is used to launch the application from a launcher or the command line.</span>
145
147
            </div></li>
146
148
          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><code>string</code></span> <b><a href="Granite.Application.app_copyright.html" class="field">app_copyright</a></b>
147
149
            </span>
148
 
            <div class="leaf_brief_description">
 
150
            <div class="leaf_brief_description"><span class="brief_description">Years that the copyright extends to. Usually from the start of the 
 
151
                project to the most recent modification to it.</span>
149
152
            </div></li>
150
153
          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><code>string</code></span> <b><a href="Granite.Application.app_years.html" class="field">app_years</a></b>
151
154
            </span>
153
156
            </div></li>
154
157
          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><code>string</code></span> <b><a href="Granite.Application.app_icon.html" class="field">app_icon</a></b>
155
158
            </span>
156
 
            <div class="leaf_brief_description">
 
159
            <div class="leaf_brief_description"><span class="brief_description">Icon to be associated with the application.</span>
157
160
            </div></li>
158
161
          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><code>string</code></span> <b><a href="Granite.Application.app_launcher.html" class="field">app_launcher</a></b>
159
162
            </span>
160
 
            <div class="leaf_brief_description">
 
163
            <div class="leaf_brief_description"><span class="brief_description">The launcher to be associated with this application.</span>
161
164
            </div></li>
162
165
          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><code>string</code></span> <b><a href="Granite.Application.main_url.html" class="field">main_url</a></b>
163
166
            </span>
164
 
            <div class="leaf_brief_description">
 
167
            <div class="leaf_brief_description"><span class="brief_description">Main website or homepage for the application.</span>
165
168
            </div></li>
166
169
          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><code>string</code></span> <b><a href="Granite.Application.bug_url.html" class="field">bug_url</a></b>
167
170
            </span>
168
 
            <div class="leaf_brief_description">
 
171
            <div class="leaf_brief_description"><span class="brief_description">A link to the software's public bug tracker.</span>
169
172
            </div></li>
170
173
          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><code>string</code></span> <b><a href="Granite.Application.help_url.html" class="field">help_url</a></b>
171
174
            </span>
172
 
            <div class="leaf_brief_description">
 
175
            <div class="leaf_brief_description"><span class="brief_description">Link to question and answer site or support forum for the app.</span>
173
176
            </div></li>
174
177
          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><code>string</code></span> <b><a href="Granite.Application.translate_url.html" class="field">translate_url</a></b>
175
178
            </span>
176
 
            <div class="leaf_brief_description">
 
179
            <div class="leaf_brief_description"><span class="brief_description">Link to where users can translate the application.</span>
177
180
            </div></li>
178
181
          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><code>string</code></span>[] <b><a href="Granite.Application.about_authors.html" class="field">about_authors</a></b>
179
182
            </span>
180
 
            <div class="leaf_brief_description">
 
183
            <div class="leaf_brief_description"><span class="brief_description">Full names of the application authors for the about dialog.</span>
181
184
            </div></li>
182
185
          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><code>string</code></span>[] <b><a href="Granite.Application.about_documenters.html" class="field">about_documenters</a></b>
183
186
            </span>
184
 
            <div class="leaf_brief_description">
 
187
            <div class="leaf_brief_description"><span class="brief_description">Full names of documenters of the app for the about dialog.</span>
185
188
            </div></li>
186
189
          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><code>string</code></span>[] <b><a href="Granite.Application.about_artists.html" class="field">about_artists</a></b>
187
190
            </span>
188
 
            <div class="leaf_brief_description">
 
191
            <div class="leaf_brief_description"><span class="brief_description">Names of the designers of the application's user interface.</span>
189
192
            </div></li>
190
193
          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><code>string</code></span> <b><a href="Granite.Application.about_comments.html" class="field">about_comments</a></b>
191
194
            </span>
193
196
            </div></li>
194
197
          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><code>string</code></span> <b><a href="Granite.Application.about_translators.html" class="field">about_translators</a></b>
195
198
            </span>
196
 
            <div class="leaf_brief_description">
 
199
            <div class="leaf_brief_description"><span class="brief_description">Names of the translators of the application.</span>
197
200
            </div></li>
198
201
          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><code>string</code></span> <b><a href="Granite.Application.about_license.html" class="field">about_license</a></b>
199
202
            </span>
200
 
            <div class="leaf_brief_description">
 
203
            <div class="leaf_brief_description"><span class="brief_description">The copyright license that the work is distributed under.</span>
201
204
            </div></li>
202
205
          <li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><code>License</code></span> <b><a href="Granite.Application.about_license_type.html" class="field">about_license_type</a></b>
203
206
            </span>