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 / Glib / Utils.pod < prev    next >
Encoding:
Text File  |  2007-03-05  |  3.1 KB  |  167 lines
  1. =head1 NAME
  2.  
  3. Glib::Utils -  Miscellaneous utility functions
  4.  
  5. =for position SYNOPSIS
  6.  
  7. =head1 SYNOPSIS
  8.  
  9.   use Glib;
  10.   Glib::set_application_name (Glib::get_real_name."'s Cool Program");
  11.  
  12.   print "app name is ".Glib::get_application_name()."\n";
  13.  
  14. =for position DESCRIPTION
  15.  
  16. =head1 DESCRIPTION
  17.  
  18. Here are some useful miscellaneous utilities.
  19. GLib is a portability library, providing portable utility functions for
  20. C programs.  As such, most of these functions seem to violate the Glib
  21. binding principle of not duplicating functionality that Perl already
  22. provides, but there's a distinction for each one, i swear.  The functions
  23. for dealing with user information are provided on all GLib-supported
  24. platforms, not just where POSIX (which provides similar information) is
  25. available, and even work on platforms where %ENV may not include the
  26. expected information.  Also, the "application name" referred to by
  27. (set|get)_application_name is a human readable name, distinct from the
  28. actual program name provided by Perl's own $0.
  29.  
  30. =cut
  31.  
  32.  
  33.  
  34. =for object Glib::Utils Miscellaneous utility functions
  35. =cut
  36.  
  37.  
  38.  
  39.  
  40. =head1 METHODS
  41.  
  42. =head2 string = Glib::get_application_name 
  43.  
  44. =over
  45.  
  46. Get the human-readable application name set by C<set_application_name>.
  47.  
  48. =back
  49.  
  50. =head2 Glib::set_application_name ($application_name)
  51.  
  52. =over
  53.  
  54. =over
  55.  
  56. =item * $application_name (string) 
  57.  
  58. =back
  59.  
  60. Set the human-readable application name.
  61.  
  62. =back
  63.  
  64. =head2 string = Glib::get_home_dir 
  65.  
  66. =over
  67.  
  68. Find the current user's home directory, by system-dependent/appropriate
  69. means.
  70.  
  71. =back
  72.  
  73. =head2 list = Glib::get_language_names 
  74.  
  75. =over
  76.  
  77. Computes a list of applicable locale names, which can be used to e.g. construct
  78. locale-dependent filenames or search paths. The returned list is sorted from
  79. most desirable to least desirable and always contains the default locale "C".
  80.  
  81. =back
  82.  
  83. =head2 string = Glib::get_real_name 
  84.  
  85. =over
  86.  
  87. Get the current user's real name.
  88.  
  89. =back
  90.  
  91. =head2 list = Glib::get_system_config_dirs 
  92.  
  93. =over
  94.  
  95. Returns an ordered list of base directories in which to access system-wide
  96. configuration information.
  97.  
  98. =back
  99.  
  100. =head2 list = Glib::get_system_data_dirs 
  101.  
  102. =over
  103.  
  104. Returns an ordered list of base directories in which to access system-wide
  105. application data.
  106.  
  107. =back
  108.  
  109. =head2 string = Glib::get_tmp_dir 
  110.  
  111. =over
  112.  
  113. Get the temp dir as appropriate for the current system.  See the GLib docs
  114. for info on how it works.
  115.  
  116. =back
  117.  
  118. =head2 string = Glib::get_user_cache_dir 
  119.  
  120. =over
  121.  
  122. Gets the base directory in which to store non-essential, cached data specific
  123. to particular user.
  124.  
  125. =back
  126.  
  127. =head2 string = Glib::get_user_config_dir 
  128.  
  129. =over
  130.  
  131. Gets the base directory in which to store user-specific application
  132. configuration information such as user preferences and settings.
  133.  
  134. =back
  135.  
  136. =head2 string = Glib::get_user_data_dir 
  137.  
  138. =over
  139.  
  140. Get the base directory for application data such as icons that is customized
  141. for a particular user.
  142.  
  143. =back
  144.  
  145. =head2 string = Glib::get_user_name 
  146.  
  147. =over
  148.  
  149. Get the current user's name by whatever system-dependent means necessary.
  150.  
  151. =back
  152.  
  153.  
  154. =head1 SEE ALSO
  155.  
  156. L<Glib>
  157.  
  158. =head1 COPYRIGHT
  159.  
  160. Copyright (C) 2003-2006 by the gtk2-perl team.
  161.  
  162. This software is licensed under the LGPL.  See L<Glib> for a full notice.
  163.  
  164.  
  165. =cut
  166.  
  167.