home *** CD-ROM | disk | FTP | other *** search
/ PC Welt 2006 November (DVD) / PCWELT_11_2006.ISO / casper / filesystem.squashfs / usr / lib / perl5 / Gnome2 / VFS / URI.pod < prev    next >
Encoding:
Text File  |  2006-06-19  |  8.9 KB  |  607 lines

  1. =head1 NAME
  2.  
  3. Gnome2::VFS::URI
  4.  
  5. =head1 HIERARCHY
  6.  
  7.   Glib::Boxed
  8.   +----Gnome2::VFS::URI
  9.  
  10.  
  11. =head1 METHODS
  12.  
  13. =head2 uri = Gnome2::VFS::URI-E<gt>B<new> ($text_uri)
  14.  
  15. =over
  16.  
  17. =over
  18.  
  19. =item * $text_uri (string) 
  20.  
  21. =back
  22.  
  23. =back
  24.  
  25. =head2 uri = $base-E<gt>B<append_file_name> ($filename)
  26.  
  27. =over
  28.  
  29. =over
  30.  
  31. =item * $filename (string) 
  32.  
  33. =back
  34.  
  35. =back
  36.  
  37. =head2 uri = $base-E<gt>B<append_path> ($path)
  38.  
  39. =over
  40.  
  41. =over
  42.  
  43. =item * $path (string) 
  44.  
  45. =back
  46.  
  47. =back
  48.  
  49. =head2 uri = $base-E<gt>B<append_string> ($uri_fragment)
  50.  
  51. =over
  52.  
  53. =over
  54.  
  55. =item * $uri_fragment (string) 
  56.  
  57. =back
  58.  
  59. =back
  60.  
  61. =head2 list = $source_uri-E<gt>B<check_same_fs> ($target_uri)
  62.  
  63. =over
  64.  
  65. =over
  66.  
  67. =item * $target_uri (Gnome2::VFS::URI) 
  68.  
  69. =back
  70.  
  71.  
  72. Returns a GnomeVFSResult and a boolean.
  73.  
  74.  
  75. =back
  76.  
  77. =head2 list = $uri-E<gt>B<create> ($open_mode, $exclusive, $perm)
  78.  
  79. =over
  80.  
  81. =over
  82.  
  83. =item * $open_mode (Gnome2::VFS::OpenMode) 
  84.  
  85. =item * $exclusive (boolean) 
  86.  
  87. =item * $perm (integer) 
  88.  
  89. =back
  90.  
  91.  
  92. Returns a GnomeVFSResult and a GnomeVFSHandle.
  93.  
  94.  
  95. =back
  96.  
  97. =head2 boolean = $a-E<gt>B<equal> ($b)
  98.  
  99. =over
  100.  
  101. =over
  102.  
  103. =item * $b (Gnome2::VFS::URI) 
  104.  
  105. =back
  106.  
  107. =back
  108.  
  109. =head2 boolean = $uri-E<gt>B<exists> 
  110.  
  111. =over
  112.  
  113. =back
  114.  
  115. =head2 string = $uri-E<gt>B<extract_dirname> 
  116.  
  117. =over
  118.  
  119. =back
  120.  
  121. =head2 string = $uri-E<gt>B<extract_short_name> 
  122.  
  123. =over
  124.  
  125. =back
  126.  
  127. =head2 string = $uri-E<gt>B<extract_short_path_name> 
  128.  
  129. =over
  130.  
  131. =back
  132.  
  133. =head2 list = $uri-E<gt>B<get_file_info> ($options)
  134.  
  135. =over
  136.  
  137. =over
  138.  
  139. =item * $options (Gnome2::VFS::FileInfoOptions) 
  140.  
  141. =back
  142.  
  143.  
  144. Returns a GnomeVFSResult and a GnomeVFSFileInfo.
  145.  
  146.  
  147. =back
  148.  
  149. =head2 result = $uri-E<gt>B<set_file_info> ($info, $mask)
  150.  
  151. =over
  152.  
  153. =over
  154.  
  155. =item * $info (Gnome2::VFS::FileInfo) 
  156.  
  157. =item * $mask (Gnome2::VFS::SetFileInfoMask) 
  158.  
  159. =back
  160.  
  161. =back
  162.  
  163. =head2 string = $uri-E<gt>B<get_fragment_identifier> 
  164.  
  165. =over
  166.  
  167. =back
  168.  
  169. =head2 boolean = $uri-E<gt>B<has_parent> 
  170.  
  171. =over
  172.  
  173. =back
  174.  
  175. =head2 string = $uri-E<gt>B<get_host_name> 
  176.  
  177. =over
  178.  
  179. =back
  180.  
  181. =head2 $uri-E<gt>B<set_host_name> ($host_name)
  182.  
  183. =over
  184.  
  185. =over
  186.  
  187. =item * $host_name (string) 
  188.  
  189. =back
  190.  
  191. =back
  192.  
  193. =head2 integer = $uri-E<gt>B<get_host_port> 
  194.  
  195. =over
  196.  
  197. =back
  198.  
  199. =head2 $uri-E<gt>B<set_host_port> ($host_port)
  200.  
  201. =over
  202.  
  203. =over
  204.  
  205. =item * $host_port (integer) 
  206.  
  207. =back
  208.  
  209. =back
  210.  
  211. =head2 boolean = $uri-E<gt>B<is_local> 
  212.  
  213. =over
  214.  
  215. =back
  216.  
  217. =head2 boolean = $possible_parent-E<gt>B<is_parent> ($possible_child, $recursive)
  218.  
  219. =over
  220.  
  221. =over
  222.  
  223. =item * $possible_child (Gnome2::VFS::URI) 
  224.  
  225. =item * $recursive (boolean) 
  226.  
  227. =back
  228.  
  229. =back
  230.  
  231. =head2 list = Gnome2::VFS::URI-E<gt>B<list_parse> ($uri_list)
  232.  
  233. =over
  234.  
  235. =over
  236.  
  237. =item * $uri_list (string) 
  238.  
  239. =back
  240.  
  241.  
  242. Returns a list of GnomeVFSURI's.
  243.  
  244.  
  245. =back
  246.  
  247. =head2 result = $uri-E<gt>B<make_directory> ($perm)
  248.  
  249. =over
  250.  
  251. =over
  252.  
  253. =item * $perm (integer) 
  254.  
  255. =back
  256.  
  257. =back
  258.  
  259. =head2 string = Gnome2::VFS::URI-E<gt>B<make_full_from_relative> ($base_uri, $relative_uri)
  260.  
  261. =over
  262.  
  263. =over
  264.  
  265. =item * $base_uri (string) 
  266.  
  267. =item * $relative_uri (string) 
  268.  
  269. =back
  270.  
  271. =back
  272.  
  273. =head2 result = $old_uri-E<gt>B<move> ($new_uri, $force_replace)
  274.  
  275. =over
  276.  
  277. =over
  278.  
  279. =item * $new_uri (Gnome2::VFS::URI) 
  280.  
  281. =item * $force_replace (boolean) 
  282.  
  283. =back
  284.  
  285. =back
  286.  
  287. =head2 list = $uri-E<gt>B<open> ($open_mode)
  288.  
  289. =over
  290.  
  291. =over
  292.  
  293. =item * $open_mode (Gnome2::VFS::OpenMode) 
  294.  
  295. =back
  296.  
  297.  
  298. Returns a GnomeVFSResult and a GnomeVFSHandle.
  299.  
  300.  
  301. =back
  302.  
  303. =head2 uri = $uri-E<gt>B<get_parent> 
  304.  
  305. =over
  306.  
  307. =back
  308.  
  309. =head2 string = $uri-E<gt>B<get_password> 
  310.  
  311. =over
  312.  
  313. =back
  314.  
  315. =head2 $uri-E<gt>B<set_password> ($password)
  316.  
  317. =over
  318.  
  319. =over
  320.  
  321. =item * $password (string) 
  322.  
  323. =back
  324.  
  325. =back
  326.  
  327. =head2 string = $uri-E<gt>B<get_path> 
  328.  
  329. =over
  330.  
  331. =back
  332.  
  333. =head2 result = $uri-E<gt>B<remove_directory> 
  334.  
  335. =over
  336.  
  337. =back
  338.  
  339. =head2 uri = $base-E<gt>B<resolve_relative> ($relative_reference)
  340.  
  341. =over
  342.  
  343. =over
  344.  
  345. =item * $relative_reference (string) 
  346.  
  347. =back
  348.  
  349. =back
  350.  
  351. =head2 string = $uri-E<gt>B<get_scheme> 
  352.  
  353. =over
  354.  
  355. =back
  356.  
  357. =head2 string = $uri-E<gt>B<to_string> ($hide_options=GNOME_VFS_URI_HIDE_NONE)
  358.  
  359. =over
  360.  
  361. =over
  362.  
  363. =item * $hide_options (Gnome2::VFS::URI::HideOptions) 
  364.  
  365. =back
  366.  
  367. =back
  368.  
  369. =head2 result = $uri-E<gt>B<truncate> ($length)
  370.  
  371. =over
  372.  
  373. =over
  374.  
  375. =item * $length (unsigned) 
  376.  
  377. =back
  378.  
  379. =back
  380.  
  381. =head2 result = $uri-E<gt>B<unlink> 
  382.  
  383. =over
  384.  
  385. =back
  386.  
  387. =head2 string = $uri-E<gt>B<get_user_name> 
  388.  
  389. =over
  390.  
  391. =back
  392.  
  393. =head2 $uri-E<gt>B<set_user_name> ($user_name)
  394.  
  395. =over
  396.  
  397. =over
  398.  
  399. =item * $user_name (string) 
  400.  
  401. =back
  402.  
  403. =back
  404.  
  405.  
  406. =head1 ENUMS AND FLAGS
  407.  
  408. =head2 flags Gnome2::VFS::FileInfoOptions
  409.  
  410. =over
  411.  
  412. =item * 'default' / 'GNOME_VFS_FILE_INFO_DEFAULT'
  413.  
  414. =item * 'get-mime-type' / 'GNOME_VFS_FILE_INFO_GET_MIME_TYPE'
  415.  
  416. =item * 'force-fast-mime-type' / 'GNOME_VFS_FILE_INFO_FORCE_FAST_MIME_TYPE'
  417.  
  418. =item * 'force-slow-mime-type' / 'GNOME_VFS_FILE_INFO_FORCE_SLOW_MIME_TYPE'
  419.  
  420. =item * 'follow-links' / 'GNOME_VFS_FILE_INFO_FOLLOW_LINKS'
  421.  
  422. =item * 'get-access-rights' / 'GNOME_VFS_FILE_INFO_GET_ACCESS_RIGHTS'
  423.  
  424. =item * 'name-only' / 'GNOME_VFS_FILE_INFO_NAME_ONLY'
  425.  
  426. =back
  427.  
  428.  
  429. =head2 flags Gnome2::VFS::OpenMode
  430.  
  431. =over
  432.  
  433. =item * 'none' / 'GNOME_VFS_OPEN_NONE'
  434.  
  435. =item * 'read' / 'GNOME_VFS_OPEN_READ'
  436.  
  437. =item * 'write' / 'GNOME_VFS_OPEN_WRITE'
  438.  
  439. =item * 'random' / 'GNOME_VFS_OPEN_RANDOM'
  440.  
  441. =item * 'truncate' / 'GNOME_VFS_OPEN_TRUNCATE'
  442.  
  443. =back
  444.  
  445.  
  446. =head2 enum Gnome2::VFS::Result
  447.  
  448. =over
  449.  
  450. =item * 'ok' / 'GNOME_VFS_OK'
  451.  
  452. =item * 'error-not-found' / 'GNOME_VFS_ERROR_NOT_FOUND'
  453.  
  454. =item * 'error-generic' / 'GNOME_VFS_ERROR_GENERIC'
  455.  
  456. =item * 'error-internal' / 'GNOME_VFS_ERROR_INTERNAL'
  457.  
  458. =item * 'error-bad-parameters' / 'GNOME_VFS_ERROR_BAD_PARAMETERS'
  459.  
  460. =item * 'error-not-supported' / 'GNOME_VFS_ERROR_NOT_SUPPORTED'
  461.  
  462. =item * 'error-io' / 'GNOME_VFS_ERROR_IO'
  463.  
  464. =item * 'error-corrupted-data' / 'GNOME_VFS_ERROR_CORRUPTED_DATA'
  465.  
  466. =item * 'error-wrong-format' / 'GNOME_VFS_ERROR_WRONG_FORMAT'
  467.  
  468. =item * 'error-bad-file' / 'GNOME_VFS_ERROR_BAD_FILE'
  469.  
  470. =item * 'error-too-big' / 'GNOME_VFS_ERROR_TOO_BIG'
  471.  
  472. =item * 'error-no-space' / 'GNOME_VFS_ERROR_NO_SPACE'
  473.  
  474. =item * 'error-read-only' / 'GNOME_VFS_ERROR_READ_ONLY'
  475.  
  476. =item * 'error-invalid-uri' / 'GNOME_VFS_ERROR_INVALID_URI'
  477.  
  478. =item * 'error-not-open' / 'GNOME_VFS_ERROR_NOT_OPEN'
  479.  
  480. =item * 'error-invalid-open-mode' / 'GNOME_VFS_ERROR_INVALID_OPEN_MODE'
  481.  
  482. =item * 'error-access-denied' / 'GNOME_VFS_ERROR_ACCESS_DENIED'
  483.  
  484. =item * 'error-too-many-open-files' / 'GNOME_VFS_ERROR_TOO_MANY_OPEN_FILES'
  485.  
  486. =item * 'error-eof' / 'GNOME_VFS_ERROR_EOF'
  487.  
  488. =item * 'error-not-a-directory' / 'GNOME_VFS_ERROR_NOT_A_DIRECTORY'
  489.  
  490. =item * 'error-in-progress' / 'GNOME_VFS_ERROR_IN_PROGRESS'
  491.  
  492. =item * 'error-interrupted' / 'GNOME_VFS_ERROR_INTERRUPTED'
  493.  
  494. =item * 'error-file-exists' / 'GNOME_VFS_ERROR_FILE_EXISTS'
  495.  
  496. =item * 'error-loop' / 'GNOME_VFS_ERROR_LOOP'
  497.  
  498. =item * 'error-not-permitted' / 'GNOME_VFS_ERROR_NOT_PERMITTED'
  499.  
  500. =item * 'error-is-directory' / 'GNOME_VFS_ERROR_IS_DIRECTORY'
  501.  
  502. =item * 'error-no-memory' / 'GNOME_VFS_ERROR_NO_MEMORY'
  503.  
  504. =item * 'error-host-not-found' / 'GNOME_VFS_ERROR_HOST_NOT_FOUND'
  505.  
  506. =item * 'error-invalid-host-name' / 'GNOME_VFS_ERROR_INVALID_HOST_NAME'
  507.  
  508. =item * 'error-host-has-no-address' / 'GNOME_VFS_ERROR_HOST_HAS_NO_ADDRESS'
  509.  
  510. =item * 'error-login-failed' / 'GNOME_VFS_ERROR_LOGIN_FAILED'
  511.  
  512. =item * 'error-cancelled' / 'GNOME_VFS_ERROR_CANCELLED'
  513.  
  514. =item * 'error-directory-busy' / 'GNOME_VFS_ERROR_DIRECTORY_BUSY'
  515.  
  516. =item * 'error-directory-not-empty' / 'GNOME_VFS_ERROR_DIRECTORY_NOT_EMPTY'
  517.  
  518. =item * 'error-too-many-links' / 'GNOME_VFS_ERROR_TOO_MANY_LINKS'
  519.  
  520. =item * 'error-read-only-file-system' / 'GNOME_VFS_ERROR_READ_ONLY_FILE_SYSTEM'
  521.  
  522. =item * 'error-not-same-file-system' / 'GNOME_VFS_ERROR_NOT_SAME_FILE_SYSTEM'
  523.  
  524. =item * 'error-name-too-long' / 'GNOME_VFS_ERROR_NAME_TOO_LONG'
  525.  
  526. =item * 'error-service-not-available' / 'GNOME_VFS_ERROR_SERVICE_NOT_AVAILABLE'
  527.  
  528. =item * 'error-service-obsolete' / 'GNOME_VFS_ERROR_SERVICE_OBSOLETE'
  529.  
  530. =item * 'error-protocol-error' / 'GNOME_VFS_ERROR_PROTOCOL_ERROR'
  531.  
  532. =item * 'error-no-master-browser' / 'GNOME_VFS_ERROR_NO_MASTER_BROWSER'
  533.  
  534. =item * 'error-no-default' / 'GNOME_VFS_ERROR_NO_DEFAULT'
  535.  
  536. =item * 'error-no-handler' / 'GNOME_VFS_ERROR_NO_HANDLER'
  537.  
  538. =item * 'error-parse' / 'GNOME_VFS_ERROR_PARSE'
  539.  
  540. =item * 'error-launch' / 'GNOME_VFS_ERROR_LAUNCH'
  541.  
  542. =item * 'error-timeout' / 'GNOME_VFS_ERROR_TIMEOUT'
  543.  
  544. =item * 'error-nameserver' / 'GNOME_VFS_ERROR_NAMESERVER'
  545.  
  546. =item * 'error-locked' / 'GNOME_VFS_ERROR_LOCKED'
  547.  
  548. =item * 'error-deprecated-function' / 'GNOME_VFS_ERROR_DEPRECATED_FUNCTION'
  549.  
  550. =item * 'num-errors' / 'GNOME_VFS_NUM_ERRORS'
  551.  
  552. =back
  553.  
  554.  
  555. =head2 flags Gnome2::VFS::SetFileInfoMask
  556.  
  557. =over
  558.  
  559. =item * 'none' / 'GNOME_VFS_SET_FILE_INFO_NONE'
  560.  
  561. =item * 'name' / 'GNOME_VFS_SET_FILE_INFO_NAME'
  562.  
  563. =item * 'permissions' / 'GNOME_VFS_SET_FILE_INFO_PERMISSIONS'
  564.  
  565. =item * 'owner' / 'GNOME_VFS_SET_FILE_INFO_OWNER'
  566.  
  567. =item * 'time' / 'GNOME_VFS_SET_FILE_INFO_TIME'
  568.  
  569. =back
  570.  
  571.  
  572. =head2 flags Gnome2::VFS::URI::HideOptions
  573.  
  574. =over
  575.  
  576. =item * 'none' / 'GNOME_VFS_URI_HIDE_NONE'
  577.  
  578. =item * 'user-name' / 'GNOME_VFS_URI_HIDE_USER_NAME'
  579.  
  580. =item * 'password' / 'GNOME_VFS_URI_HIDE_PASSWORD'
  581.  
  582. =item * 'host-name' / 'GNOME_VFS_URI_HIDE_HOST_NAME'
  583.  
  584. =item * 'host-port' / 'GNOME_VFS_URI_HIDE_HOST_PORT'
  585.  
  586. =item * 'toplevel-method' / 'GNOME_VFS_URI_HIDE_TOPLEVEL_METHOD'
  587.  
  588. =item * 'fragment-identifier' / 'GNOME_VFS_URI_HIDE_FRAGMENT_IDENTIFIER'
  589.  
  590. =back
  591.  
  592.  
  593.  
  594. =head1 SEE ALSO
  595.  
  596. L<Gnome2::VFS>, L<Glib::Boxed>
  597.  
  598. =head1 COPYRIGHT
  599.  
  600. Copyright (C) 2003-2004 by the gtk2-perl team.
  601.  
  602. This software is licensed under the LGPL.  See L<Gnome2::VFS> for a full notice.
  603.  
  604.  
  605. =cut
  606.  
  607.