/usr/include/giomm-2.4/giomm/mountoperation.h is in libglibmm-2.4-dev 2.42.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 | // -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GIOMM_MOUNTOPERATION_H
#define _GIOMM_MOUNTOPERATION_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
// -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*-
/* Copyright (C) 2007 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <glibmm/object.h>
#include <glibmm/arrayhandle.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GMountOperation GMountOperation;
typedef struct _GMountOperationClass GMountOperationClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{ class MountOperation_Class; } // namespace Gio
namespace Gio
{
/** @addtogroup giommEnums giomm Enums and Flags */
/**
* @var AskPasswordFlags ASK_PASSWORD_NEED_PASSWORD
* Operation requires a password.
*
* @var AskPasswordFlags ASK_PASSWORD_NEED_USERNAME
* Operation requires a username.
*
* @var AskPasswordFlags ASK_PASSWORD_NEED_DOMAIN
* Operation requires a domain.
*
* @var AskPasswordFlags ASK_PASSWORD_SAVING_SUPPORTED
* Operation supports saving settings.
*
* @var AskPasswordFlags ASK_PASSWORD_ANONYMOUS_SUPPORTED
* Operation supports anonymous users.
*
* @enum AskPasswordFlags
*
* AskPasswordFlags are used to request specific information from the
* user, or to notify the user of their choices in an authentication
* situation.
* @ingroup giommEnums
* @par Bitwise operators:
* <tt>%AskPasswordFlags operator|(AskPasswordFlags, AskPasswordFlags)</tt><br>
* <tt>%AskPasswordFlags operator&(AskPasswordFlags, AskPasswordFlags)</tt><br>
* <tt>%AskPasswordFlags operator^(AskPasswordFlags, AskPasswordFlags)</tt><br>
* <tt>%AskPasswordFlags operator~(AskPasswordFlags)</tt><br>
* <tt>%AskPasswordFlags& operator|=(AskPasswordFlags&, AskPasswordFlags)</tt><br>
* <tt>%AskPasswordFlags& operator&=(AskPasswordFlags&, AskPasswordFlags)</tt><br>
* <tt>%AskPasswordFlags& operator^=(AskPasswordFlags&, AskPasswordFlags)</tt><br>
*/
enum AskPasswordFlags
{
ASK_PASSWORD_NEED_PASSWORD = (1 << 0),
ASK_PASSWORD_NEED_USERNAME = (1 << 1),
ASK_PASSWORD_NEED_DOMAIN = (1 << 2),
ASK_PASSWORD_SAVING_SUPPORTED = (1 << 3),
ASK_PASSWORD_ANONYMOUS_SUPPORTED = (1 << 4)
};
/** @ingroup giommEnums */
inline AskPasswordFlags operator|(AskPasswordFlags lhs, AskPasswordFlags rhs)
{ return static_cast<AskPasswordFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline AskPasswordFlags operator&(AskPasswordFlags lhs, AskPasswordFlags rhs)
{ return static_cast<AskPasswordFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline AskPasswordFlags operator^(AskPasswordFlags lhs, AskPasswordFlags rhs)
{ return static_cast<AskPasswordFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline AskPasswordFlags operator~(AskPasswordFlags flags)
{ return static_cast<AskPasswordFlags>(~static_cast<unsigned>(flags)); }
/** @ingroup giommEnums */
inline AskPasswordFlags& operator|=(AskPasswordFlags& lhs, AskPasswordFlags rhs)
{ return (lhs = static_cast<AskPasswordFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline AskPasswordFlags& operator&=(AskPasswordFlags& lhs, AskPasswordFlags rhs)
{ return (lhs = static_cast<AskPasswordFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline AskPasswordFlags& operator^=(AskPasswordFlags& lhs, AskPasswordFlags rhs)
{ return (lhs = static_cast<AskPasswordFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
/**
* @var PasswordSave PASSWORD_SAVE_NEVER
* Never save a password.
*
* @var PasswordSave PASSWORD_SAVE_FOR_SESSION
* Save a password for the session.
*
* @var PasswordSave PASSWORD_SAVE_PERMANENTLY
* Save a password permanently.
*
* @enum PasswordSave
*
* PasswordSave is used to indicate the lifespan of a saved password.
*
* #Gvfs stores passwords in the Gnome keyring when this flag allows it
* to, and later retrieves it again from there.
* @ingroup giommEnums
*/
enum PasswordSave
{
PASSWORD_SAVE_NEVER,
PASSWORD_SAVE_FOR_SESSION,
PASSWORD_SAVE_PERMANENTLY
};
/**
* @var MountOperationResult MOUNT_OPERATION_HANDLED
* The request was fulfilled and the user specified data is now available.
*
* @var MountOperationResult MOUNT_OPERATION_ABORTED
* The user requested the mount operation to be aborted.
*
* @var MountOperationResult MOUNT_OPERATION_UNHANDLED
* The request was unhandled (i.e. not implemented).
*
* @enum MountOperationResult
*
* MountOperationResult is returned as a result when a request for
* information is send by the mounting operation.
* @ingroup giommEnums
*/
enum MountOperationResult
{
MOUNT_OPERATION_HANDLED,
MOUNT_OPERATION_ABORTED,
MOUNT_OPERATION_UNHANDLED
};
/** Authentication methods for mountable locations.
*
* MountOperation provides a mechanism for authenticating mountable operations, such as loop mounting files, hard drive partitions or server locations.
*
* Mounting operations are handed a MountOperation that they can use if they require any privileges or authentication for their volumes to be mounted (e.g.
* a hard disk partition or an encrypted filesystem), or if they are implementing a remote server protocol which requires user credentials such as FTP or
* WebDAV.
*
* Developers should instantiate a subclass of this that implements all the various callbacks to show the required dialogs.
*
* @newin{2,16}
*/
class MountOperation : public Glib::Object
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef MountOperation CppObjectType;
typedef MountOperation_Class CppClassType;
typedef GMountOperation BaseObjectType;
typedef GMountOperationClass BaseClassType;
private: friend class MountOperation_Class;
static CppClassType mountoperation_class_;
private:
// noncopyable
MountOperation(const MountOperation&);
MountOperation& operator=(const MountOperation&);
protected:
explicit MountOperation(const Glib::ConstructParams& construct_params);
explicit MountOperation(GMountOperation* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~MountOperation();
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GMountOperation* gobj() { return reinterpret_cast<GMountOperation*>(gobject_); }
///Provides access to the underlying C GObject.
const GMountOperation* gobj() const { return reinterpret_cast<GMountOperation*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GMountOperation* gobj_copy();
private:
protected:
MountOperation();
public:
static Glib::RefPtr<MountOperation> create();
/** Get the user name from the mount operation.
*
* @return A string containing the user name.
*/
Glib::ustring get_username() const;
/** Sets the user name within @a op to @a username.
*
* @param username Input username.
*/
void set_username(const Glib::ustring& username);
/** Gets a password from the mount operation.
*
* @return A string containing the password within @a op.
*/
Glib::ustring get_password() const;
/** Sets the mount operation's password to @a password.
*
* @param password Password to set.
*/
void set_password(const Glib::ustring& password);
/** Check to see whether the mount operation is being used
* for an anonymous user.
*
* @return <tt>true</tt> if mount operation is anonymous.
*/
bool get_anonymous() const;
/** Sets the mount operation to use an anonymous user if @a anonymous is <tt>true</tt>.
*
* @param anonymous Boolean value.
*/
void set_anonymous(bool anonymous = true);
/** Gets the domain of the mount operation.
*
* @return A string set to the domain.
*/
Glib::ustring get_domain() const;
/** Sets the mount operation's domain.
*
* @param domain The domain to set.
*/
void set_domain(const Glib::ustring& domain);
/** Gets the state of saving passwords for the mount operation.
*
* @return A PasswordSave flag.
*/
PasswordSave get_password_save() const;
/** Sets the state of saving passwords for the mount operation.
*
* @param save A set of PasswordSave flags.
*/
void set_password_save(PasswordSave save);
/** Gets a choice from the mount operation.
*
* @return An integer containing an index of the user's choice from
* the choice's list, or %0.
*/
int get_choice() const;
/** Sets a default choice for the mount operation.
*
* @param choice An integer.
*/
void set_choice(int choice);
/** Emits the MountOperation::signal_reply() signal.
*
* @param result A MountOperationResult.
*/
void reply(MountOperationResult result);
/**
* @par Slot Prototype:
* <tt>void on_my_%ask_password(const Glib::ustring& message, const Glib::ustring& default_user, const Glib::ustring& default_domain, AskPasswordFlags flags)</tt>
*
* Emitted when a mount operation asks the user for a password.
*
* If the message contains a line break, the first line should be
* presented as a heading. For example, it may be used as the
* primary text in a Gtk::MessageDialog.
*
* @param message String containing a message to display to the user.
* @param default_user String containing the default user name.
* @param default_domain String containing the default domain.
* @param flags A set of AskPasswordFlags.
*/
Glib::SignalProxy4< void,const Glib::ustring&,const Glib::ustring&,const Glib::ustring&,AskPasswordFlags > signal_ask_password();
//TODO: We really need some test to make sure that our use of StringArrayHandle is correct. murrayc.
/**
* @par Slot Prototype:
* <tt>void on_my_%ask_question(const Glib::ustring& message, const Glib::StringArrayHandle& choices)</tt>
*
* Emitted when asking the user a question and gives a list of
* choices for the user to choose from.
*
* If the message contains a line break, the first line should be
* presented as a heading. For example, it may be used as the
* primary text in a Gtk::MessageDialog.
*
* @param message String containing a message to display to the user.
* @param choices An array of strings for each possible choice.
*/
Glib::SignalProxy2< void,const Glib::ustring&,const Glib::StringArrayHandle& > signal_ask_question();
/**
* @par Slot Prototype:
* <tt>void on_my_%reply(MountOperationResult result)</tt>
*
* Emitted when the user has replied to the mount operation.
*
* @param result A MountOperationResult indicating how the request was handled.
*/
Glib::SignalProxy1< void,MountOperationResult > signal_reply();
//TODO: Remove no_default_handler when we can break ABI:
/**
* @par Slot Prototype:
* <tt>void on_my_%aborted()</tt>
*
* Emitted by the backend when e.g.\ a device becomes unavailable
* while a mount operation is in progress.
*
* Implementations of GMountOperation should handle this signal
* by dismissing open password dialogs.
*
* @newin{2,20}
*
*/
Glib::SignalProxy0< void > signal_aborted();
//TODO: The array of char* is not very pleasant to wrap:
//_WRAP_SIGNAL( void show_processes(const Glib::ustring& message, GArray* processes, const gchar *choices[]);
/**
* @par Slot Prototype:
* <tt>void on_my_%show_unmount_progress(const Glib::ustring& message, gint64 time_left, gint64 bytes_left)</tt>
*
* Emitted when an unmount operation has been busy for more than some time
* (typically 1.5 seconds).
*
* When unmounting or ejecting a volume, the kernel might need to flush
* pending data in its buffers to the volume stable storage, and this operation
* can take a considerable amount of time. This signal may be emitted several
* times as long as the unmount operation is outstanding, and then one
* last time when the operation is completed, with @a bytes_left set to zero.
*
* Implementations of GMountOperation should handle this signal by
* showing an UI notification, and then dismiss it, or show another notification
* of completion, when @a bytes_left reaches zero.
*
* If the message contains a line break, the first line should be
* presented as a heading. For example, it may be used as the
* primary text in a Gtk::MessageDialog.
*
* @newin{2,34}
*
* @param message String containing a mesage to display to the user.
* @param time_left The estimated time left before the operation completes,
* in microseconds, or -1.
* @param bytes_left The amount of bytes to be written before the operation
* completes (or -1 if such amount is not known), or zero if the operation
* is completed.
*/
Glib::SignalProxy3< void,const Glib::ustring&,gint64,gint64 > signal_show_unmount_progress();
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The user name.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::ustring > property_username() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The user name.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_username() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The password.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::ustring > property_password() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The password.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_password() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Whether to use an anonymous user.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_anonymous() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Whether to use an anonymous user.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_anonymous() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The domain of the mount operation.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::ustring > property_domain() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The domain of the mount operation.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_domain() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** How passwords should be saved.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< PasswordSave > property_password_save() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** How passwords should be saved.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< PasswordSave > property_password_save() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The users choice.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< int > property_choice() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The users choice.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< int > property_choice() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
/// This is a default handler for the signal signal_ask_password().
virtual void on_ask_password(const Glib::ustring& message, const Glib::ustring& default_user, const Glib::ustring& default_domain, AskPasswordFlags flags);
/// This is a default handler for the signal signal_ask_question().
virtual void on_ask_question(const Glib::ustring& message, const Glib::StringArrayHandle& choices);
/// This is a default handler for the signal signal_reply().
virtual void on_reply(MountOperationResult result);
};
} // namespace Gio
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gio::MountOperation
*/
Glib::RefPtr<Gio::MountOperation> wrap(GMountOperation* object, bool take_copy = false);
}
#endif /* _GIOMM_MOUNTOPERATION_H */
|