|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
<html>
|
|
Packit |
4b6dd7 |
<head>
|
|
Packit |
4b6dd7 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
4b6dd7 |
<title>GDataComparable: GData Reference Manual</title>
|
|
Packit |
4b6dd7 |
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
|
|
Packit |
4b6dd7 |
<link rel="home" href="index.html" title="GData Reference Manual">
|
|
Packit |
4b6dd7 |
<link rel="up" href="ch02.html" title="Core API">
|
|
Packit |
4b6dd7 |
<link rel="prev" href="GDataUploadStream.html" title="GDataUploadStream">
|
|
Packit |
4b6dd7 |
<link rel="next" href="ch03.html" title="Access Control List API">
|
|
Packit |
4b6dd7 |
<meta name="generator" content="GTK-Doc V1.26.1 (XML mode)">
|
|
Packit |
4b6dd7 |
<link rel="stylesheet" href="style.css" type="text/css">
|
|
Packit |
4b6dd7 |
</head>
|
|
Packit |
4b6dd7 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Top |
|
|
Packit |
4b6dd7 |
Description |
|
|
Packit |
4b6dd7 |
Object Hierarchy |
|
|
Packit |
4b6dd7 |
Known Implementations
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataComparable
|
|
Packit |
4b6dd7 |
GDataComparable — GData comparable interface
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Stability Level
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
develop applications to these interfaces, release them, and have confidence that
|
|
Packit |
4b6dd7 |
they will run on all minor releases of the product (after the one in which the
|
|
Packit |
4b6dd7 |
interface was introduced, and within the same major release). Even at a major
|
|
Packit |
4b6dd7 |
release, incompatible changes are expected to be rare, and to have strong
|
|
Packit |
4b6dd7 |
justifications.
|
|
Packit |
4b6dd7 |
">Stable, unless otherwise indicated
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Functions
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gint
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_comparable_compare ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Types and Values
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataComparable
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataComparableIface
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Object Hierarchy
|
|
Packit |
4b6dd7 |
GInterface
|
|
Packit |
4b6dd7 |
╰── GDataComparable
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Known Implementations
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataComparable is implemented by
|
|
Packit |
4b6dd7 |
GDataAuthor, GDataCategory, GDataGContactCalendar, GDataGContactExternalID, GDataGContactLanguage, GDataGContactWebsite, GDataGDEmailAddress, GDataGDIMAddress, GDataGDName, GDataGDOrganization, GDataGDPhoneNumber, GDataGDPostalAddress, GDataGDReminder, GDataGDWhen, GDataGDWhere, GDataGDWho, GDataGenerator, GDataLink and GDataYouTubeCategory.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Includes
|
|
Packit |
4b6dd7 |
#include <gdata/gdata-comparable.h>
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Description
|
|
Packit |
4b6dd7 |
GDataComparable is an interface which can be implemented by any object which needs to be compared to another object of the same type or of a
|
|
Packit |
4b6dd7 |
derived type.
|
|
Packit |
4b6dd7 |
When implementing the interface, classes must implement the compare_with function, and the implementation must be
|
|
Packit |
4b6dd7 |
pure
|
|
Packit |
4b6dd7 |
.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Functions
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_comparable_compare ()
|
|
Packit |
4b6dd7 |
gint
|
|
Packit |
4b6dd7 |
gdata_comparable_compare (GDataComparable *self,
|
|
Packit |
4b6dd7 |
GDataComparable *other);
|
|
Packit |
4b6dd7 |
Compares the two objects, returning -1 if self
|
|
Packit |
4b6dd7 |
is "less than" other
|
|
Packit |
4b6dd7 |
by some metric, 0
|
|
Packit |
4b6dd7 |
if they're equal, or 1 if self
|
|
Packit |
4b6dd7 |
is "greater than" other
|
|
Packit |
4b6dd7 |
.
|
|
Packit |
4b6dd7 |
NULL values are handled gracefully, with 0 returned if both self
|
|
Packit |
4b6dd7 |
and other
|
|
Packit |
4b6dd7 |
are NULL,
|
|
Packit |
4b6dd7 |
-1 if self is NULL and 1 if other is NULL.
|
|
Packit |
4b6dd7 |
The other
|
|
Packit |
4b6dd7 |
object must be of the same type as self
|
|
Packit |
4b6dd7 |
, or of a type derived from self
|
|
Packit |
4b6dd7 |
's type.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
self
|
|
Packit |
4b6dd7 |
a GDataComparable, or NULL.
|
|
Packit |
4b6dd7 |
[allow-none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
other
|
|
Packit |
4b6dd7 |
another GDataComparable of the same type, or NULL.
|
|
Packit |
4b6dd7 |
[allow-none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
TRUE on success, FALSE otherwise
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Types and Values
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataComparable
|
|
Packit |
4b6dd7 |
typedef struct _GDataComparable GDataComparable;
|
|
Packit |
4b6dd7 |
All the fields in the GDataComparable structure are private and should never be accessed directly.
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataComparableIface
|
|
Packit |
4b6dd7 |
typedef struct {
|
|
Packit |
4b6dd7 |
GTypeInterface parent;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gint (*compare_with) (GDataComparable *self, GDataComparable *other);
|
|
Packit |
4b6dd7 |
} GDataComparableIface;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The class structure for the GDataComparable interface.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Members
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GTypeInterface parent;
|
|
Packit |
4b6dd7 |
the parent type
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
compare_with ()
|
|
Packit |
4b6dd7 |
compares the object with an other
|
|
Packit |
4b6dd7 |
object of the same type, returning -1 if the object is "less than"
|
|
Packit |
4b6dd7 |
the other object, 0 if they're equal, or 1 if the object is "greater than" the other. The
|
|
Packit |
4b6dd7 |
function can assume that neither self
|
|
Packit |
4b6dd7 |
or other
|
|
Packit |
4b6dd7 |
will be NULL, and that both have correct types. The function must be pure.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Generated by GTK-Doc V1.26.1
|
|
Packit |
4b6dd7 |
</body>
|
|
Packit |
4b6dd7 |
</html>
|