You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

243 line
14 KiB

  1. /* GIO - GLib Input, Output and Streaming Library
  2. *
  3. * Copyright (C) 2006-2008 Red Hat, Inc.
  4. *
  5. * This library is free software; you can redistribute it and/or
  6. * modify it under the terms of the GNU Lesser General Public
  7. * License as published by the Free Software Foundation; either
  8. * version 2 of the License, or (at your option) any later version.
  9. *
  10. * This library is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  13. * Lesser General Public License for more details.
  14. *
  15. * You should have received a copy of the GNU Lesser General
  16. * Public License along with this library; if not, write to the
  17. * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18. * Boston, MA 02111-1307, USA.
  19. *
  20. * Author: Alexander Larsson <alexl@redhat.com>
  21. * David Zeuthen <davidz@redhat.com>
  22. */
  23. #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  24. #error "Only <gio/gio.h> can be included directly."
  25. #endif
  26. #ifndef __G_MOUNT_H__
  27. #define __G_MOUNT_H__
  28. #include <gio/giotypes.h>
  29. G_BEGIN_DECLS
  30. #define G_TYPE_MOUNT (g_mount_get_type ())
  31. #define G_MOUNT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_MOUNT, GMount))
  32. #define G_IS_MOUNT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_MOUNT))
  33. #define G_MOUNT_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_MOUNT, GMountIface))
  34. typedef struct _GMountIface GMountIface;
  35. /**
  36. * GMountIface:
  37. * @g_iface: The parent interface.
  38. * @changed: Changed signal that is emitted when the mount's state has changed.
  39. * @unmounted: The unmounted signal that is emitted when the #GMount have been unmounted. If the recipient is holding references to the object they should release them so the object can be finalized.
  40. * @pre_unmount: The pre_unmout signal that is emitted when the #GMount will soon be emitted. If the recipient is somehow holding the mount open by keeping an open file on it it should close the file.
  41. * @get_root: Gets a #GFile to the root directory of the #GMount.
  42. * @get_name: Gets a string containing the name of the #GMount.
  43. * @get_icon: Gets a #GIcon for the #GMount.
  44. * @get_uuid: Gets the UUID for the #GMount. The reference is typically based on the file system UUID for the mount in question and should be considered an opaque string. Returns %NULL if there is no UUID available.
  45. * @get_volume: Gets a #GVolume the mount is located on. Returns %NULL if the #GMount is not associated with a #GVolume.
  46. * @get_drive: Gets a #GDrive the volume of the mount is located on. Returns %NULL if the #GMount is not associated with a #GDrive or a #GVolume. This is convenience method for getting the #GVolume and using that to get the #GDrive.
  47. * @can_unmount: Checks if a #GMount can be unmounted.
  48. * @can_eject: Checks if a #GMount can be ejected.
  49. * @unmount: Starts unmounting a #GMount.
  50. * @unmount_finish: Finishes an unmounting operation.
  51. * @eject: Starts ejecting a #GMount.
  52. * @eject_finish: Finishes an eject operation.
  53. * @remount: Starts remounting a #GMount.
  54. * @remount_finish: Finishes a remounting operation.
  55. * @guess_content_type: Starts guessing the type of the content of a #GMount.
  56. * See g_mount_guess_content_type() for more information on content
  57. * type guessing. This operation was added in 2.18.
  58. * @guess_content_type_finish: Finishes a contenet type guessing operation. Added in 2.18.
  59. * @guess_content_type_sync: Synchronous variant of @guess_content_type. Added in 2.18
  60. * @unmount_with_operation: Starts unmounting a #GMount using a #GMountOperation. Since 2.22.
  61. * @unmount_with_operation_finish: Finishes an unmounting operation using a #GMountOperation. Since 2.22.
  62. * @eject_with_operation: Starts ejecting a #GMount using a #GMountOperation. Since 2.22.
  63. * @eject_with_operation_finish: Finishes an eject operation using a #GMountOperation. Since 2.22.
  64. * @get_default_location: Gets a #GFile indication a start location that can be use as the entry point for this mount. Since 2.24.
  65. *
  66. * Interface for implementing operations for mounts.
  67. **/
  68. struct _GMountIface
  69. {
  70. GTypeInterface g_iface;
  71. /* signals */
  72. void (* changed) (GMount *mount);
  73. void (* unmounted) (GMount *mount);
  74. /* Virtual Table */
  75. GFile * (* get_root) (GMount *mount);
  76. char * (* get_name) (GMount *mount);
  77. GIcon * (* get_icon) (GMount *mount);
  78. char * (* get_uuid) (GMount *mount);
  79. GVolume * (* get_volume) (GMount *mount);
  80. GDrive * (* get_drive) (GMount *mount);
  81. gboolean (* can_unmount) (GMount *mount);
  82. gboolean (* can_eject) (GMount *mount);
  83. void (* unmount) (GMount *mount,
  84. GMountUnmountFlags flags,
  85. GCancellable *cancellable,
  86. GAsyncReadyCallback callback,
  87. gpointer user_data);
  88. gboolean (* unmount_finish) (GMount *mount,
  89. GAsyncResult *result,
  90. GError **error);
  91. void (* eject) (GMount *mount,
  92. GMountUnmountFlags flags,
  93. GCancellable *cancellable,
  94. GAsyncReadyCallback callback,
  95. gpointer user_data);
  96. gboolean (* eject_finish) (GMount *mount,
  97. GAsyncResult *result,
  98. GError **error);
  99. void (* remount) (GMount *mount,
  100. GMountMountFlags flags,
  101. GMountOperation *mount_operation,
  102. GCancellable *cancellable,
  103. GAsyncReadyCallback callback,
  104. gpointer user_data);
  105. gboolean (* remount_finish) (GMount *mount,
  106. GAsyncResult *result,
  107. GError **error);
  108. void (* guess_content_type) (GMount *mount,
  109. gboolean force_rescan,
  110. GCancellable *cancellable,
  111. GAsyncReadyCallback callback,
  112. gpointer user_data);
  113. gchar ** (* guess_content_type_finish) (GMount *mount,
  114. GAsyncResult *result,
  115. GError **error);
  116. gchar ** (* guess_content_type_sync) (GMount *mount,
  117. gboolean force_rescan,
  118. GCancellable *cancellable,
  119. GError **error);
  120. /* Signal, not VFunc */
  121. void (* pre_unmount) (GMount *mount);
  122. void (* unmount_with_operation) (GMount *mount,
  123. GMountUnmountFlags flags,
  124. GMountOperation *mount_operation,
  125. GCancellable *cancellable,
  126. GAsyncReadyCallback callback,
  127. gpointer user_data);
  128. gboolean (* unmount_with_operation_finish) (GMount *mount,
  129. GAsyncResult *result,
  130. GError **error);
  131. void (* eject_with_operation) (GMount *mount,
  132. GMountUnmountFlags flags,
  133. GMountOperation *mount_operation,
  134. GCancellable *cancellable,
  135. GAsyncReadyCallback callback,
  136. gpointer user_data);
  137. gboolean (* eject_with_operation_finish) (GMount *mount,
  138. GAsyncResult *result,
  139. GError **error);
  140. GFile * (* get_default_location) (GMount *mount);
  141. };
  142. GType g_mount_get_type (void) G_GNUC_CONST;
  143. GFile * g_mount_get_root (GMount *mount);
  144. GFile * g_mount_get_default_location (GMount *mount);
  145. char * g_mount_get_name (GMount *mount);
  146. GIcon * g_mount_get_icon (GMount *mount);
  147. char * g_mount_get_uuid (GMount *mount);
  148. GVolume * g_mount_get_volume (GMount *mount);
  149. GDrive * g_mount_get_drive (GMount *mount);
  150. gboolean g_mount_can_unmount (GMount *mount);
  151. gboolean g_mount_can_eject (GMount *mount);
  152. #ifndef G_DISABLE_DEPRECATED
  153. void g_mount_unmount (GMount *mount,
  154. GMountUnmountFlags flags,
  155. GCancellable *cancellable,
  156. GAsyncReadyCallback callback,
  157. gpointer user_data);
  158. gboolean g_mount_unmount_finish (GMount *mount,
  159. GAsyncResult *result,
  160. GError **error);
  161. void g_mount_eject (GMount *mount,
  162. GMountUnmountFlags flags,
  163. GCancellable *cancellable,
  164. GAsyncReadyCallback callback,
  165. gpointer user_data);
  166. gboolean g_mount_eject_finish (GMount *mount,
  167. GAsyncResult *result,
  168. GError **error);
  169. #endif
  170. void g_mount_remount (GMount *mount,
  171. GMountMountFlags flags,
  172. GMountOperation *mount_operation,
  173. GCancellable *cancellable,
  174. GAsyncReadyCallback callback,
  175. gpointer user_data);
  176. gboolean g_mount_remount_finish (GMount *mount,
  177. GAsyncResult *result,
  178. GError **error);
  179. void g_mount_guess_content_type (GMount *mount,
  180. gboolean force_rescan,
  181. GCancellable *cancellable,
  182. GAsyncReadyCallback callback,
  183. gpointer user_data);
  184. gchar ** g_mount_guess_content_type_finish (GMount *mount,
  185. GAsyncResult *result,
  186. GError **error);
  187. gchar ** g_mount_guess_content_type_sync (GMount *mount,
  188. gboolean force_rescan,
  189. GCancellable *cancellable,
  190. GError **error);
  191. gboolean g_mount_is_shadowed (GMount *mount);
  192. void g_mount_shadow (GMount *mount);
  193. void g_mount_unshadow (GMount *mount);
  194. void g_mount_unmount_with_operation (GMount *mount,
  195. GMountUnmountFlags flags,
  196. GMountOperation *mount_operation,
  197. GCancellable *cancellable,
  198. GAsyncReadyCallback callback,
  199. gpointer user_data);
  200. gboolean g_mount_unmount_with_operation_finish (GMount *mount,
  201. GAsyncResult *result,
  202. GError **error);
  203. void g_mount_eject_with_operation (GMount *mount,
  204. GMountUnmountFlags flags,
  205. GMountOperation *mount_operation,
  206. GCancellable *cancellable,
  207. GAsyncReadyCallback callback,
  208. gpointer user_data);
  209. gboolean g_mount_eject_with_operation_finish (GMount *mount,
  210. GAsyncResult *result,
  211. GError **error);
  212. G_END_DECLS
  213. #endif /* __G_MOUNT_H__ */