home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2007 September / PCWSEP07.iso / Software / Linux / Linux Mint 3.0 Light / LinuxMint-3.0-Light.iso / casper / filesystem.squashfs / usr / lib / perl5 / Gnome2 / Program.pod < prev    next >
Encoding:
Text File  |  2006-06-19  |  4.1 KB  |  248 lines
  1. =head1 NAME
  2.  
  3. Gnome2::Program
  4.  
  5. =head1 HIERARCHY
  6.  
  7.   Glib::Object
  8.   +----Gnome2::Program
  9.  
  10.  
  11. =head1 METHODS
  12.  
  13. =head2 string = $program-E<gt>B<get_app_id> 
  14.  
  15. =over
  16.  
  17. =back
  18.  
  19. =head2 string = $program-E<gt>B<get_app_version> 
  20.  
  21. =over
  22.  
  23. =back
  24.  
  25. =head2 string = $program-E<gt>B<get_human_readable_name> 
  26.  
  27. =over
  28.  
  29. =back
  30.  
  31. =head2 program = Gnome2::Program-E<gt>B<init> ($app_id, $app_version, $module_info=undef, ...)
  32.  
  33. =over
  34.  
  35. =over
  36.  
  37. =item * $app_id (string) 
  38.  
  39. =item * $app_version (string) 
  40.  
  41. =item * $module_info (scalar) 
  42.  
  43. =item * ... (list) 
  44.  
  45. =back
  46.  
  47.  
  48. The list argument is for property-value pairs.
  49.  
  50.  
  51. =back
  52.  
  53. =head2 list = $program-E<gt>B<locate_file> ($domain, $file_name, $only_if_exists)
  54.  
  55. =over
  56.  
  57. =over
  58.  
  59. =item * $domain (Gnome2::FileDomain) 
  60.  
  61. =item * $file_name (string) 
  62.  
  63. =item * $only_if_exists (boolean) 
  64.  
  65. =back
  66.  
  67.  
  68. Returns a list of locations.
  69.  
  70.  
  71. =back
  72.  
  73. =head2 moduleinfo = Gnome2::Program-E<gt>B<module_load> ($mod_name)
  74.  
  75. =over
  76.  
  77. =over
  78.  
  79. =item * $mod_name (string) 
  80.  
  81. =back
  82.  
  83. =back
  84.  
  85. =head2 Gnome2::Program-E<gt>B<module_register> ($module_info)
  86.  
  87. =over
  88.  
  89. =over
  90.  
  91. =item * $module_info (scalar) 
  92.  
  93. =back
  94.  
  95. =back
  96.  
  97. =head2 boolean = Gnome2::Program-E<gt>B<module_registered> ($module_info)
  98.  
  99. =over
  100.  
  101. =over
  102.  
  103. =item * $module_info (scalar) 
  104.  
  105. =back
  106.  
  107. =back
  108.  
  109. =head2 program or undef = Gnome2::Program-E<gt>B<get_program> 
  110.  
  111. =over
  112.  
  113. =back
  114.  
  115.  
  116. =head1 PROPERTIES
  117.  
  118. =over
  119.  
  120. =item 'app-datadir' (string : readable / writable)
  121.  
  122. Data prefix where this application was installed
  123.  
  124. =item 'app-id' (string : readable)
  125.  
  126. ID string to use for this application
  127.  
  128. =item 'app-libdir' (string : readable / writable)
  129.  
  130. Library prefix where this application was installed
  131.  
  132. =item 'app-prefix' (string : readable / writable)
  133.  
  134. Prefix where this application was installed
  135.  
  136. =item 'app-sysconfdir' (string : readable / writable)
  137.  
  138. Configuration prefix where this application was installed
  139.  
  140. =item 'app-version' (string : readable)
  141.  
  142. Version of this application
  143.  
  144. =item 'create-directories' (boolean : readable / writable / construct-only)
  145.  
  146. Create standard GNOME directories on startup
  147.  
  148. =item 'enable-sound' (boolean : readable / writable)
  149.  
  150. Enable sound on startup
  151.  
  152. =item 'espeaker' (string : readable / writable)
  153.  
  154. How to connect to esd
  155.  
  156. =item 'gnome-datadir' (string : readable / writable / construct-only)
  157.  
  158. Data prefix where GNOME was installed
  159.  
  160. =item 'gnome-libdir' (string : readable / writable / construct-only)
  161.  
  162. Library prefix where GNOME was installed
  163.  
  164. =item 'gnome-path' (string : readable / writable / construct-only)
  165.  
  166. Path in which to look for installed files
  167.  
  168. =item 'gnome-prefix' (string : readable / writable / construct-only)
  169.  
  170. Prefix where GNOME was installed
  171.  
  172. =item 'gnome-sysconfdir' (string : readable / writable / construct-only)
  173.  
  174. Configuration prefix where GNOME was installed
  175.  
  176. =item 'goption-context' (gpointer : readable / writable / construct-only)
  177.  
  178. The goption context pointer that GnomeProgram is using
  179.  
  180. =item 'human-readable-name' (string : readable / writable / construct-only)
  181.  
  182. Human readable name of this application
  183.  
  184. =item 'popt-context' (gpointer : readable)
  185.  
  186. The popt context pointer that GnomeProgram is using
  187.  
  188. =item 'popt-flags' (integer : writable / construct-only)
  189.  
  190. The flags to use for popt
  191.  
  192. =item 'popt-table' (gpointer : writable / construct-only)
  193.  
  194. The table of options for popt
  195.  
  196. =back
  197.  
  198.  
  199. =head1 ENUMS AND FLAGS
  200.  
  201. =head2 enum Gnome2::FileDomain
  202.  
  203. =over
  204.  
  205. =item * 'unknown' / 'GNOME_FILE_DOMAIN_UNKNOWN'
  206.  
  207. =item * 'libdir' / 'GNOME_FILE_DOMAIN_LIBDIR'
  208.  
  209. =item * 'datadir' / 'GNOME_FILE_DOMAIN_DATADIR'
  210.  
  211. =item * 'sound' / 'GNOME_FILE_DOMAIN_SOUND'
  212.  
  213. =item * 'pixmap' / 'GNOME_FILE_DOMAIN_PIXMAP'
  214.  
  215. =item * 'config' / 'GNOME_FILE_DOMAIN_CONFIG'
  216.  
  217. =item * 'help' / 'GNOME_FILE_DOMAIN_HELP'
  218.  
  219. =item * 'app-libdir' / 'GNOME_FILE_DOMAIN_APP_LIBDIR'
  220.  
  221. =item * 'app-datadir' / 'GNOME_FILE_DOMAIN_APP_DATADIR'
  222.  
  223. =item * 'app-sound' / 'GNOME_FILE_DOMAIN_APP_SOUND'
  224.  
  225. =item * 'app-pixmap' / 'GNOME_FILE_DOMAIN_APP_PIXMAP'
  226.  
  227. =item * 'app-config' / 'GNOME_FILE_DOMAIN_APP_CONFIG'
  228.  
  229. =item * 'app-help' / 'GNOME_FILE_DOMAIN_APP_HELP'
  230.  
  231. =back
  232.  
  233.  
  234.  
  235. =head1 SEE ALSO
  236.  
  237. L<Gnome2>, L<Glib::Object>
  238.  
  239. =head1 COPYRIGHT
  240.  
  241. Copyright (C) 2003-2004 by the gtk2-perl team.
  242.  
  243. This software is licensed under the LGPL.  See L<Gnome2> for a full notice.
  244.  
  245.  
  246. =cut
  247.  
  248.