blob: 3d050e171bc439c1bf73d239163b5375a63cfea5 (
plain) (
tree)
|
|
<!-- ##### FUNCTION cal_client_load_calendar ##### -->
<para>
</para>
@client:
@str_uri:
@Returns:
<!-- ##### FUNCTION cal_client_create_calendar ##### -->
<para>
</para>
@client:
@str_uri:
@Returns:
<!-- ##### SIGNAL CalClient::cal-opened ##### -->
<para>
</para>
@calclient: the object which received the signal.
@arg1:
<!-- ##### FUNCTION cal_client_get_events_in_range ##### -->
<para>
</para>
@client:
@start:
@end:
@Returns:
<!-- ##### SIGNAL CalClient::cal-loaded ##### -->
<para>
This signal is emitted some time after the calendar clients sends
a load or create request to the personal calendar server. The
server will notify the client asynchronously of the completion of
the request. The @status parameter indicates the status of the
request.
</para>
@calclient: the object which received the signal.
@arg1:
@client: Calendar client which received the notification.
@status: Status of the request. See the description of
#CalClientLoadStatus for more details.
<!-- ##### FUNCTION cal_client_is_loaded ##### -->
<para>
</para>
@client:
@Returns:
<!-- ##### SIGNAL CalClient::obj-updated ##### -->
<para>
This signal is emitted when the calendar clients receives
notification of a calendar component's data being changed in the
personal calendar server. Graphical clients may want to get the
new version of the object and update their display, for example.
</para>
@calclient: the object which received the signal.
@arg1:
@client: Calendar client which received the notification.
@uid: Unique identifier of the calendar component that changed in the
personal calendar server's storage.
<!-- ##### FUNCTION cal_client_update_pilot_id ##### -->
<para>
</para>
@client:
@uid:
@pilot_id:
@pilot_status:
<!-- ##### ENUM CalClientLoadStatus ##### -->
<para>
These values describe the status of a calendar load or create
request. After asking a calendar factory to load or create a
calendar, the provided listener will get notification about the
result in asynchronous fashion. Such notification is represented
by one of these enumeration values. For values other than
#CAL_CLIENT_LOAD_SUCCESS, the #CalClient object will not accept
any other operations on the calendar and it should just be
destroyed.
</para>
<!-- ##### FUNCTION cal_client_get_uid_by_pilot_id ##### -->
<para>
</para>
@client:
@pilot_id:
@uid:
@Returns:
<!-- ##### SIGNAL CalClient::obj-removed ##### -->
<para>
This signal is emitted when the calendar client receives
notification for a calendar component being removed from the
storage in the personal calendar server. Graphical clients may
want to delete the corresponding object from their display, for
example.
</para>
@calclient: the object which received the signal.
@arg1:
@client: Calendar client which received the notification.
@uid: Unique identifier of the calendar component that was removed
from the personal calendar server's storage.
<!--
Local variables:
mode: sgml
sgml-parent-document: ("../../../evolution-devel-guide.sgml" "book" "refsect2" "")
End:
-->
|