galago-context.h File Reference

Galago Context API. More...

#include <libgalago/galago-context-base.h>
#include <libgalago/galago-person.h>
#include <libgalago/galago-service.h>

Go to the source code of this file.


Galago Context API
GalagoContext *	galago_context_new (void)
	Creates a new context.
void	galago_context_destroy (GalagoContext *context)
	Destroys a context.
void	galago_context_push (GalagoContext *context)
	Pushes a context onto the stack.
void	galago_context_pop (void)
	Pops a context off the stack.
GalagoContext *	galago_context_get (void)
	Returns the current context.
void	galago_context_set_obj_path_prefix (const char *prefix)
	Sets the base object path prefix for this context.
const char *	galago_context_get_obj_path_prefix (void)
	Returns the base object path prefix for this context.
GalagoService *	galago_context_get_service (const char *id, galago_bool native)
	Returns the service with the specified ID.
const GalagoList *	galago_context_get_services (galago_bool native)
	Returns a list of all services.
GalagoPerson *	galago_context_get_person (const char *id, galago_bool native)
	Returns the person with the specified ID.
const GalagoList *	galago_context_get_people (galago_bool native)
	Returns a list of all people.
void *	galago_context_get_object (const char *path)
	Finds an object with the specified path.

Detailed Description

Galago Context API.

Copyright:: (C) 2004-2005 Christian Hammond

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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Definition in file galago-context.h.

Function Documentation

void galago_context_destroy

(

GalagoContext *

context

)

Destroys a context.

Parameters:

context

The context to destroy.

GalagoContext* galago_context_get

(

void

)

Returns the current context.

Returns:: The current context.

const char* galago_context_get_obj_path_prefix

(

void

)

Returns the base object path prefix for this context.

Returns:: The object path prefix.

void* galago_context_get_object

(

const char *

path

)

Finds an object with the specified path.

Parameters:

path

The D-BUS object path.

Returns:: The object if found, or NULL.

const GalagoList* galago_context_get_people

(

galago_bool

native

)

Returns a list of all people.

Parameters:

native

TRUE if the desired people are native.

Returns:: The list of people, if found, or NULL.

GalagoPerson* galago_context_get_person	(	const char *	id,
		galago_bool	native
	)

Returns the person with the specified ID.

Parameters:

	id	The person ID.
	native	TRUE if the desired person is native.

Returns:: The person, if found, or NULL.

GalagoService* galago_context_get_service	(	const char *	id,
		galago_bool	native
	)

Returns the service with the specified ID.

Parameters:

	id	The service ID.
	native	TRUE if the desired service is native.

Returns:: The service, if found, or NULL.

const GalagoList* galago_context_get_services

(

galago_bool

native

)

Returns a list of all services.

Parameters:

native

TRUE if the desired services are native.

Returns:: The list of services, if found, or NULL.

GalagoContext* galago_context_new

(

void

)

Creates a new context.

Returns:: The new context.

void galago_context_push

(

GalagoContext *

context

)

Pushes a context onto the stack.

Parameters:

context

The context to push.

void galago_context_set_obj_path_prefix

(

const char *

prefix

)

Sets the base object path prefix for this context.

Parameters:

prefix

The object path prefix.