Libgnomedb 4.0 Reference Manual

Rodrigo Moya

<rodrigo@gnome-db.org>

Vivien Malerba

<malerba@gnome-db.org>

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license can be found in Appendix A, GNU Free Documentation License.

Many of the names used by companies to distinguish their products and services are claimed as trademarks. Where those names appear in any GNOME documentation, and those trademarks are made aware to the members of the GNOME Documentation Project, the names have been printed in caps or initial caps.

Abstract

libgnomedb is a data-bound UI library, based on libgda.

I. Getting started

Introduction

libgnomedb features

libgnomedb architecture

A small example

Application presentation and context

Database structure

The customers table
The orders table
The order_contents table
The products table

Coding the application

Choice of objects
Complete code
Compiling

Widget Gallery

Migration from 1.X versions

Global changes
GnomeDbGrid and GnomeDbForm widgets changes

Migration from 3.X versions

Overview
Global changes

II. libgnomedb API Reference

Object Hierarchy

Initialization — Library initialization and main loop

Datasources and connection related widgets

GnomeDbProviderSelector — A combo box style widget to select a provider
GnomeDbProviderAuthEditor — Widget to display and edit authentication information associated to a database provider
GnomeDbProviderSpecEditor — Widget to display and edit connection data associated to a database provider
GnomeDbDsnSelector — Choose a data source
GnomeDbLogin — Login widget
GnomeDbLoginDialog — Login dialog widget
GnomeDbDsnEditor — A form to modify datasource information
GnomeDbDsnAssistant — an assistant to create a new datasource
GnomeDbConnectionProperties — Shows the properties of a GdaConnection object
GnomeDbServerOperation — Allow to set the contents of a GdaServerOperation object
GnomeDbTransastionStatus — Displays the transaction status of a connection

Data bound widgets

GnomeDbCombo — A combo box with data to be displayed as a GdaDataModel
GnomeDbBasicForm — A GUI form to present data in a GdaSet
GnomeDbRawForm — Form to display and modify data in a GdaDataModel
GnomeDbForm — Form to display and modify data in a GdaDataModel, with command buttons and indicators
GnomeDbRawGrid — Grid to display and modify data in a GdaDataModel
GnomeDbGrid — Database grid widget to display and modify data in a GdaDataModel, with command buttons and indicators
GnomeDbFindDialog — A dialog to enter a string to search among a GdaDataModel
GnomeDbDataWidget — Interface to control data bound widgets
GnomeDbDataWidgetFilter — Display and edit filtering options
GnomeDbDataWidgetInfo — Widget to display control buttons and information about data displayed in a GnomeDbDataWidget widget
GnomeDbDataStore — Implements the GtkTreeModel interface
GnomeDbDataImport — Data import widget

Individual data entry widgets

Utilities — Create GnomeDbDataEntry and GtkCellRenderer objects easily
GnomeDbDataEntry — Interface which provides the user with specific widgets to manipulate data
GnomeDbFormatEntry — A GtkEntry with formatting options
GnomeDbEntryString
GnomeDbEntryBoolean
GnomeDbEntryTime — Widget to enter a HH:MM:SS time value
GnomeDbEntryDate — Widget to enter a date value
GnomeDbEntryTimestamp — Widget to enter a time stamp value (Date + HH:MM:SS)
GnomeDbEntryNone — Default handling of unknown data types
GnomeDbEntryCombo — A combo box to choose a value from a GdaSet
GnomeDbEntryCidr — Specific for Postgres's CIDR data type
GnomeDbEntryPassword — Used to enter a password
GnomeDbEntryText
GnomeDbEntryFilesel

Cell renderers

GnomeDbDataCellRendererInfo — Cell renderer to display a cell contextual menu
GnomeDbDataCellRendererTextual — Cell renderer for textual data
GnomeDbDataCellRendererBoolean — Cell renderer for booleans
GnomeDbDataCellRendererCombo

Extra widgets

GnomeDbSqlConsole
GnomeDbEditor — A general purpose SQL editor
GnomeDbSelector — Individual selection of libgnomedb objects (data types, functions, ...)
GnomeDbSelectorPart
GnomeDbSelectorMeta
GnomeDbSelectorSchema
GnomeDbSelectorTable
GnomeDbSelectorView
GnomeDbErrorDialog — Error dialog widget
GnomeDbError — Error display widget
GnomeDbReportEditor — A reports editor (Not yet implemented)
GnomeDbGrayBar — Nice looking gray bar widget. TODO: That is a terrible description. murrayc.

Graph widgets

GnomeDbCanvasColumn
GnomeDbGraph
GnomeDbGraphItem
GnomeDbCanvas — Base class for all the GnomeCanvas derived widgets in libgnomedb.
GnomeDbCanvasDbRelations — Graphical representation of the relations (foreign key constreints) in the database.
GnomeDbCanvasItem — Base class for all the GnomeCanvasItem derived widgets in libgnomedb.
GnomeDbCanvasPrint
GnomeDbCanvasTable
GnomeDbCanvasTip — Draws a "tooltip" text
GnomeDbCanvasCursor — Represents a small cursor used when a drag and drop operations occurs within the canvas
GnomeDbCanvasText — Base class for GnomeDbCanvasItem objects rendering a GdaObject's name as a text
GnomeDbCanvasFkey

Miscellaneous

List of enumerated — Enumerated values
Stock icons — icons to reuse

Non instantiable objects and widgets

GnomeDbEntryShell — Provides the necessary button to control ths state of a GnomeDbDataEntry
GnomeDbEntryWrapper — Abstract class that implements the GnomeDbDataEntry interface
GnomeDbEntryCommonTime — Base class for time related data entry widgets

III. Appendix

A. GNU Free Documentation License

0. PREAMBLE
1. APPLICABILITY AND DEFINITIONS
2. VERBATIM COPYING
3. COPYING IN QUANTITY
4. MODIFICATIONS
5. COMBINING DOCUMENTS
6. COLLECTIONS OF DOCUMENTS
7. AGGREGATION WITH INDEPENDENT WORKS
8. TRANSLATION
9. TERMINATION
10. FUTURE REVISIONS OF THIS LICENSE
Addendum

Index