/usr/include/giomm-2.4/giomm/tlspassword.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 | // -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GIOMM_TLSPASSWORD_H
#define _GIOMM_TLSPASSWORD_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/* Copyright (C) 2012 The giomm 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>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GTlsPassword GTlsPassword;
typedef struct _GTlsPasswordClass GTlsPasswordClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{ class TlsPassword_Class; } // namespace Gio
namespace Gio
{
/** @addtogroup giommEnums giomm Enums and Flags */
/**
* @var TlsPasswordFlags TLS_PASSWORD_NONE
* No flags.
*
* @var TlsPasswordFlags TLS_PASSWORD_RETRY
* The password was wrong, and the user should retry.
*
* @var TlsPasswordFlags TLS_PASSWORD_MANY_TRIES
* Hint to the user that the password has been wrong many times, and the user may not have many chances left.
*
* @var TlsPasswordFlags TLS_PASSWORD_FINAL_TRY
* Hint to the user that this is the last try to get this password right.
*
* @enum TlsPasswordFlags
*
* Various flags for the password.
*
* @newin{2,30}
* @ingroup giommEnums
* @par Bitwise operators:
* <tt>%TlsPasswordFlags operator|(TlsPasswordFlags, TlsPasswordFlags)</tt><br>
* <tt>%TlsPasswordFlags operator&(TlsPasswordFlags, TlsPasswordFlags)</tt><br>
* <tt>%TlsPasswordFlags operator^(TlsPasswordFlags, TlsPasswordFlags)</tt><br>
* <tt>%TlsPasswordFlags operator~(TlsPasswordFlags)</tt><br>
* <tt>%TlsPasswordFlags& operator|=(TlsPasswordFlags&, TlsPasswordFlags)</tt><br>
* <tt>%TlsPasswordFlags& operator&=(TlsPasswordFlags&, TlsPasswordFlags)</tt><br>
* <tt>%TlsPasswordFlags& operator^=(TlsPasswordFlags&, TlsPasswordFlags)</tt><br>
*/
enum TlsPasswordFlags
{
TLS_PASSWORD_NONE = 0x0,
TLS_PASSWORD_RETRY = 1 << 1,
TLS_PASSWORD_MANY_TRIES = 1 << 2,
TLS_PASSWORD_FINAL_TRY = 1 << 3
};
/** @ingroup giommEnums */
inline TlsPasswordFlags operator|(TlsPasswordFlags lhs, TlsPasswordFlags rhs)
{ return static_cast<TlsPasswordFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline TlsPasswordFlags operator&(TlsPasswordFlags lhs, TlsPasswordFlags rhs)
{ return static_cast<TlsPasswordFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline TlsPasswordFlags operator^(TlsPasswordFlags lhs, TlsPasswordFlags rhs)
{ return static_cast<TlsPasswordFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline TlsPasswordFlags operator~(TlsPasswordFlags flags)
{ return static_cast<TlsPasswordFlags>(~static_cast<unsigned>(flags)); }
/** @ingroup giommEnums */
inline TlsPasswordFlags& operator|=(TlsPasswordFlags& lhs, TlsPasswordFlags rhs)
{ return (lhs = static_cast<TlsPasswordFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline TlsPasswordFlags& operator&=(TlsPasswordFlags& lhs, TlsPasswordFlags rhs)
{ return (lhs = static_cast<TlsPasswordFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline TlsPasswordFlags& operator^=(TlsPasswordFlags& lhs, TlsPasswordFlags rhs)
{ return (lhs = static_cast<TlsPasswordFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
} // namespace Gio
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gio::TlsPasswordFlags> : public Glib::Value_Flags<Gio::TlsPasswordFlags>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{
/** TlsPassword - TLS Passwords for prompting.
* Holds a password used in TLS.
* @newin{2,36}
*/
class TlsPassword : public Glib::Object
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef TlsPassword CppObjectType;
typedef TlsPassword_Class CppClassType;
typedef GTlsPassword BaseObjectType;
typedef GTlsPasswordClass BaseClassType;
private: friend class TlsPassword_Class;
static CppClassType tlspassword_class_;
private:
// noncopyable
TlsPassword(const TlsPassword&);
TlsPassword& operator=(const TlsPassword&);
protected:
explicit TlsPassword(const Glib::ConstructParams& construct_params);
explicit TlsPassword(GTlsPassword* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~TlsPassword();
/** 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.
GTlsPassword* gobj() { return reinterpret_cast<GTlsPassword*>(gobject_); }
///Provides access to the underlying C GObject.
const GTlsPassword* gobj() const { return reinterpret_cast<GTlsPassword*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GTlsPassword* gobj_copy();
private:
protected:
explicit TlsPassword(const Glib::ustring& description, TlsPasswordFlags flags = Gio::TLS_PASSWORD_NONE);
public:
/** Create a new TlsPassword object.
*
* @param flags The password flags.
* @param description Description of what the password is for.
* @return The newly allocated password object.
*/
static Glib::RefPtr<TlsPassword> create(const Glib::ustring& description, TlsPasswordFlags flags = Gio::TLS_PASSWORD_NONE);
/** Get the password value. If @a length is not <tt>0</tt> then it will be
* filled in with the length of the password value. (Note that the
* password value is not nul-terminated, so you can only pass <tt>0</tt>
* for @a length in contexts where you know the password will have a
* certain fixed length.)
*
* @newin{2,30}
*
* @param length Location to place the length of the password.
* @return The password value (owned by the password object).
*/
const guchar* get_value(gsize& length) const;
/// A get_value() convenience overload.
const guchar* get_value() const;
/** Set the value for this password. The @a value will be copied by the password
* object.
*
* Specify the @a length, for a non-nul-terminated password. Pass -1 as
* @a length if using a nul-terminated password, and @a length will be
* calculated automatically. (Note that the terminating nul is not
* considered part of the password in this case.)
*
* @newin{2,30}
*
* @param value The new password value.
* @param length The length of the password, or -1.
*/
void set_value(const guchar* value, gssize length = -1);
// This function does not copy the value as g_tls_password_set_value() does.
// It keeps a reference to the original value and expects it to be freed
// later in a specified GDestroyNotify callback. Ignore it for now.
/** Get a description string about what the password will be used for.
*
* @newin{2,30}
*
* @return The description of the password.
*/
Glib::ustring get_description() const;
/** Set a description string about what the password will be used for.
*
* @newin{2,30}
*
* @param description The description of the password.
*/
void set_description(const Glib::ustring& description);
/** Get flags about the password.
*
* @newin{2,30}
*
* @return The flags about the password.
*/
TlsPasswordFlags get_flags() const;
/** Set flags about the password.
*
* @newin{2,30}
*
* @param flags The flags about the password.
*/
void set_flags(TlsPasswordFlags flags);
/** Get a user readable translated warning. Usually this warning is a
* representation of the password flags returned from
* g_tls_password_get_flags().
*
* @newin{2,30}
*
* @return The warning.
*/
Glib::ustring get_warning() const;
/** Set a user readable translated warning. Usually this warning is a
* representation of the password flags returned from
* g_tls_password_get_flags().
*
* @newin{2,30}
*
* @param warning The user readable warning.
*/
void set_warning(const Glib::ustring& warning);
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Description of what the password is for.
*
* 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_description() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Description of what the password is for.
*
* 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_description() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Flags about 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< TlsPasswordFlags > property_flags() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Flags about 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< TlsPasswordFlags > property_flags() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Warning about 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_warning() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Warning about 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_warning() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
virtual const guchar* get_value_vfunc(gsize& length) const;
//TODO? (See g_tls_password_set_value_full() comment above): _WRAP_VFUNC(void set_value(guchar* value, gssize length, GDestroyNotify destroy), "set_value")
virtual Glib::ustring get_default_warning_vfunc() const;
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
};
} // 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::TlsPassword
*/
Glib::RefPtr<Gio::TlsPassword> wrap(GTlsPassword* object, bool take_copy = false);
}
#endif /* _GIOMM_TLSPASSWORD_H */
|