source-git / gcr

Clone
Source Code
GIT

Blame docs/reference/gcr/html/GcrCollection.html

c8 c8s master
  1.   b00eeb04ed99e7486f76dabe082c410d0627c81e
  2.   docs
  3.   reference
  4.   gcr
  5.   html
  6.   GcrCollection.html
Blob History Raw
Packit b00eeb
Packit b00eeb 
<html>
Packit b00eeb 
<head>
Packit b00eeb 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit b00eeb 
<title>GcrCollection: Gcr Library Reference Manual</title>
Packit b00eeb 
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit b00eeb 
<link rel="home" href="index.html" title="Gcr Library Reference Manual">
Packit b00eeb 
<link rel="up" href="collections.html" title="Part II. Collections">
Packit b00eeb 
<link rel="prev" href="collections.html" title="Part II. Collections">
Packit b00eeb 
<link rel="next" href="GcrComparable.html" title="GcrComparable">
Packit b00eeb 
<meta name="generator" content="GTK-Doc V1.27.1 (XML mode)">
Packit b00eeb 
<link rel="stylesheet" href="style.css" type="text/css">
Packit b00eeb 
</head>
Packit b00eeb 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit b00eeb
Packit b00eeb
Packit b00eeb 
Top  | 
Packit b00eeb 
                  Description  | 
Packit b00eeb 
                  Object Hierarchy  | 
Packit b00eeb 
                  Prerequisites  | 
Packit b00eeb 
                  Known Implementations  | 
Packit b00eeb 
                  Signals
Packit b00eeb
Packit b00eeb 
Home
Packit b00eeb 
Up
Packit b00eeb 
Prev
Packit b00eeb 
Next
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
GcrCollection
Packit b00eeb 
GcrCollection — A collection of objects.
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
Functions
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
guint
Packit b00eeb
Packit b00eeb
Packit b00eeb 
gcr_collection_get_length ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
GList *
Packit b00eeb
Packit b00eeb
Packit b00eeb 
gcr_collection_get_objects ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
gboolean
Packit b00eeb
Packit b00eeb
Packit b00eeb 
gcr_collection_contains ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
void
Packit b00eeb
Packit b00eeb
Packit b00eeb 
gcr_collection_emit_added ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
void
Packit b00eeb
Packit b00eeb
Packit b00eeb 
gcr_collection_emit_removed ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
Signals
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
void
Packit b00eeb 
added
Packit b00eeb 
Run Last
Packit b00eeb
Packit b00eeb
Packit b00eeb 
void
Packit b00eeb 
removed
Packit b00eeb 
Run Last
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
Types and Values
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
 
Packit b00eeb 
GcrCollection
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
Object Hierarchy
Packit b00eeb 
    GInterface
Packit b00eeb 
    ╰── GcrCollection
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
Prerequisites
Packit b00eeb
Packit b00eeb 
GcrCollection requires
Packit b00eeb 
 GObject.
Packit b00eeb
Packit b00eeb
Packit b00eeb 
Known Implementations
Packit b00eeb
Packit b00eeb 
GcrCollection is implemented by
Packit b00eeb 
 GcrFilterCollection,  GcrSimpleCollection and  GcrUnionCollection.
Packit b00eeb
Packit b00eeb
Packit b00eeb 
Description
Packit b00eeb 
A GcrCollection is used to group a set of objects. This is an abstract
Packit b00eeb 
interface which can be used to determine which objects show up in a selector
Packit b00eeb 
or other user interface element.
Packit b00eeb 
Use gcr_simple_collection_new() to create a concrete implementation of this
Packit b00eeb 
interface which you can add objects to.
Packit b00eeb
Packit b00eeb
Packit b00eeb 
Functions
Packit b00eeb
Packit b00eeb 
gcr_collection_get_length ()
Packit b00eeb 
guint
Packit b00eeb 
gcr_collection_get_length (GcrCollection *self);
Packit b00eeb 
Get the number of objects in this collection.
Packit b00eeb
Packit b00eeb 
Parameters
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
self
Packit b00eeb 
The collection
Packit b00eeb 
 
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
Returns
Packit b00eeb 
 The number of objects.
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
gcr_collection_get_objects ()
Packit b00eeb 
GList *
Packit b00eeb 
gcr_collection_get_objects (GcrCollection *self);
Packit b00eeb 
Get a list of the objects in this collection.
Packit b00eeb
Packit b00eeb 
Parameters
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
self
Packit b00eeb 
The collection
Packit b00eeb 
 
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
Returns
Packit b00eeb 
a list of the objects
Packit b00eeb 
in this collection, which should be freed with g_list_free().
Packit b00eeb 
[transfer container][element-type GObject.Object]
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
gcr_collection_contains ()
Packit b00eeb 
gboolean
Packit b00eeb 
gcr_collection_contains (GcrCollection *self,
Packit b00eeb 
                         GObject *object);
Packit b00eeb 
Check whether the collection contains an object or not.
Packit b00eeb
Packit b00eeb 
Parameters
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
self
Packit b00eeb 
the collection
Packit b00eeb 
 
Packit b00eeb
Packit b00eeb
Packit b00eeb 
object
Packit b00eeb 
object to check
Packit b00eeb 
 
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
Returns
Packit b00eeb 
 whether the collection contains this object
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
gcr_collection_emit_added ()
Packit b00eeb 
void
Packit b00eeb 
gcr_collection_emit_added (GcrCollection *self,
Packit b00eeb 
                           GObject *object);
Packit b00eeb 
Emit the “added” signal for the given object. This function
Packit b00eeb 
is used by implementors of this interface.
Packit b00eeb
Packit b00eeb 
Parameters
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
self
Packit b00eeb 
The collection
Packit b00eeb 
 
Packit b00eeb
Packit b00eeb
Packit b00eeb 
object
Packit b00eeb 
The object that was added
Packit b00eeb 
 
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
gcr_collection_emit_removed ()
Packit b00eeb 
void
Packit b00eeb 
gcr_collection_emit_removed (GcrCollection *self,
Packit b00eeb 
                             GObject *object);
Packit b00eeb 
Emit the “removed” signal for the given object. This function
Packit b00eeb 
is used by implementors of this interface.
Packit b00eeb
Packit b00eeb 
Parameters
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
self
Packit b00eeb 
The collection
Packit b00eeb 
 
Packit b00eeb
Packit b00eeb
Packit b00eeb 
object
Packit b00eeb 
The object that was removed
Packit b00eeb 
 
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
Types and Values
Packit b00eeb
Packit b00eeb 
GcrCollection
Packit b00eeb 
typedef struct _GcrCollection GcrCollection;
Packit b00eeb 
A GcrCollection is used to group a set of objects.
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
Signal Details
Packit b00eeb
Packit b00eeb 
The “added” signal
Packit b00eeb 
void
Packit b00eeb 
user_function (GcrCollection *self,
Packit b00eeb 
               GObject       *object,
Packit b00eeb 
               gpointer       user_data)
Packit b00eeb 
This signal is emitted when an object is added to the collection.
Packit b00eeb
Packit b00eeb 
Parameters
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
self
Packit b00eeb 
the collection
Packit b00eeb 
 
Packit b00eeb
Packit b00eeb
Packit b00eeb 
object
Packit b00eeb 
object that was added.
Packit b00eeb 
[type GObject.Object]
Packit b00eeb
Packit b00eeb
Packit b00eeb 
user_data
Packit b00eeb 
user data set when the signal handler was connected.
Packit b00eeb 
 
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
Flags: Run Last
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
The “removed” signal
Packit b00eeb 
void
Packit b00eeb 
user_function (GcrCollection *self,
Packit b00eeb 
               GObject       *object,
Packit b00eeb 
               gpointer       user_data)
Packit b00eeb 
This signal is emitted when an object is removed from the collection.
Packit b00eeb
Packit b00eeb 
Parameters
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
self
Packit b00eeb 
the collection
Packit b00eeb 
 
Packit b00eeb
Packit b00eeb
Packit b00eeb 
object
Packit b00eeb 
object that was removed.
Packit b00eeb 
[type GObject.Object]
Packit b00eeb
Packit b00eeb
Packit b00eeb 
user_data
Packit b00eeb 
user data set when the signal handler was connected.
Packit b00eeb 
 
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
Flags: Run Last
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb 
Generated by GTK-Doc V1.27.1
Packit b00eeb 
</body>
Packit b00eeb 
</html>

Powered by Pagure 5.14.1

SSH Hostkey/Fingerprint | Documentation