From fe8aea1c3b5348347633da18a02b0bffd3b266a1 Mon Sep 17 00:00:00 2001 From: Perberos Date: Thu, 1 Dec 2011 21:42:39 -0300 Subject: moving from https://github.com/perberos/mate-desktop-environment --- doc/Makefile.am | 90 ++ doc/Makefile.in | 520 +++++++ doc/html/MateWeatherLocationEntry.html | 226 +++ doc/html/MateWeatherTimezoneMenu.html | 184 +++ doc/html/ch01.html | 56 + doc/html/home.png | Bin 0 -> 654 bytes doc/html/index.html | 59 + doc/html/index.sgml | 180 +++ doc/html/left.png | Bin 0 -> 459 bytes doc/html/libmateweather-mateweather-location.html | 620 ++++++++ doc/html/libmateweather-mateweather-mateconf.html | 405 +++++ doc/html/libmateweather-mateweather-prefs.html | 396 +++++ doc/html/libmateweather-mateweather-timezone.html | 231 +++ doc/html/libmateweather-mateweather-xml.html | 70 + doc/html/libmateweather-weather.html | 1639 +++++++++++++++++++++ doc/html/libmateweather.devhelp | 151 ++ doc/html/libmateweather.devhelp2 | 158 ++ doc/html/right.png | Bin 0 -> 472 bytes doc/html/style.css | 257 ++++ doc/html/up.png | Bin 0 -> 406 bytes doc/libmateweather-docs.sgml | 25 + doc/libmateweather-overrides.txt | 0 doc/libmateweather-sections.txt | 185 +++ doc/libmateweather.types | 5 + doc/tmpl/libmateweather-unused.sgml | 493 +++++++ doc/tmpl/location-entry.sgml | 73 + doc/tmpl/mateweather-enum-types.sgml | 34 + doc/tmpl/mateweather-location.sgml | 210 +++ doc/tmpl/mateweather-mateconf.sgml | 136 ++ doc/tmpl/mateweather-prefs.sgml | 169 +++ doc/tmpl/mateweather-timezone.sgml | 87 ++ doc/tmpl/mateweather-xml.sgml | 27 + doc/tmpl/parser.sgml | 74 + doc/tmpl/timezone-menu.sgml | 62 + doc/tmpl/weather-priv.sgml | 430 ++++++ doc/tmpl/weather.sgml | 683 +++++++++ 36 files changed, 7935 insertions(+) create mode 100644 doc/Makefile.am create mode 100644 doc/Makefile.in create mode 100644 doc/html/MateWeatherLocationEntry.html create mode 100644 doc/html/MateWeatherTimezoneMenu.html create mode 100644 doc/html/ch01.html create mode 100644 doc/html/home.png create mode 100644 doc/html/index.html create mode 100644 doc/html/index.sgml create mode 100644 doc/html/left.png create mode 100644 doc/html/libmateweather-mateweather-location.html create mode 100644 doc/html/libmateweather-mateweather-mateconf.html create mode 100644 doc/html/libmateweather-mateweather-prefs.html create mode 100644 doc/html/libmateweather-mateweather-timezone.html create mode 100644 doc/html/libmateweather-mateweather-xml.html create mode 100644 doc/html/libmateweather-weather.html create mode 100644 doc/html/libmateweather.devhelp create mode 100644 doc/html/libmateweather.devhelp2 create mode 100644 doc/html/right.png create mode 100644 doc/html/style.css create mode 100644 doc/html/up.png create mode 100644 doc/libmateweather-docs.sgml create mode 100644 doc/libmateweather-overrides.txt create mode 100644 doc/libmateweather-sections.txt create mode 100644 doc/libmateweather.types create mode 100644 doc/tmpl/libmateweather-unused.sgml create mode 100644 doc/tmpl/location-entry.sgml create mode 100644 doc/tmpl/mateweather-enum-types.sgml create mode 100644 doc/tmpl/mateweather-location.sgml create mode 100644 doc/tmpl/mateweather-mateconf.sgml create mode 100644 doc/tmpl/mateweather-prefs.sgml create mode 100644 doc/tmpl/mateweather-timezone.sgml create mode 100644 doc/tmpl/mateweather-xml.sgml create mode 100644 doc/tmpl/parser.sgml create mode 100644 doc/tmpl/timezone-menu.sgml create mode 100644 doc/tmpl/weather-priv.sgml create mode 100644 doc/tmpl/weather.sgml (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..1e02b60 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,90 @@ +## Process this file with automake to produce Makefile.in + +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 + +# The name of the module, e.g. 'glib'. +DOC_MODULE=libmateweather + +# Uncomment for versioned docs and specify the version of the module, e.g. '2'. +#DOC_MODULE_VERSION=2 + +# The top-level SGML file. You can change this if you want to. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting the functions and macros. +# e.g. DOC_SOURCE_DIR=../../../gtk +DOC_SOURCE_DIR=../libmateweather + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS= + +# Extra options to supply to gtkdoc-scan +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS=--deprecated-guards="MATEWEATHER_DISABLE_DEPRECATED" + +# Extra options to supply to gtkdoc-mkdb. +# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml +MKDB_OPTIONS=--sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-mktmpl +# e.g. MKTMPL_OPTIONS=--only-section-tmpl +MKTMPL_OPTIONS= + +# Extra options to supply to gtkdoc-mkhtml +MKHTML_OPTIONS= + +# Extra options to supply to gtkdoc-fixref. Not normally needed. +# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +FIXXREF_OPTIONS= + +# Used for dependencies. The docs will be rebuilt if any of these change. +# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h +# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c +HFILE_GLOB=$(top_srcdir)/libmateweather/*.h +CFILE_GLOB=$(top_srcdir)/libmateweather/*.c + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES=mateweather-enum-types.h mateweather-win32.h parser.h weather-priv.h + +# Images to copy into HTML directory. +# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png +HTML_IMAGES= + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +# e.g. content_files=running.sgml building.sgml changes-2.0.sgml +content_files= + +# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded +# These files must be listed here *and* in content_files +# e.g. expand_content_files=running.sgml +expand_content_files= + +# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. +# Only needed if you are using gtkdoc-scangobj to dynamically query widget +# signals and properties. +# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +GTKDOC_CFLAGS = -I$(top_srcdir) $(GTK_CFLAGS) $(LIBXML_CFLAGS) $(LIBSOUP_CFLAGS) $(MATECONF_CFLAGS) -DMATEWEATHER_I_KNOW_THIS_IS_UNSTABLE +GTKDOC_LIBS = $(top_builddir)/libmateweather/libmateweather.la $(GTK_LIBS) $(LIBXML_LIBS) $(LIBSOUP_LIBS) $(MATECONF_LIBS) + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += + +# Files not to distribute +# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types +# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt +#DISTCLEANFILES += + +# Comment this out if you want your docs-status tested during 'make check' +#TESTS = $(GTKDOC_CHECK) + + +-include $(top_srcdir)/git.mk diff --git a/doc/Makefile.in b/doc/Makefile.in new file mode 100644 index 0000000..80c051d --- /dev/null +++ b/doc/Makefile.in @@ -0,0 +1,520 @@ +# Makefile.in generated by automake 1.11.1 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, +# Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \ + $(top_srcdir)/gtk-doc.make +subdir = doc +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/m4/gtk-doc.m4 \ + $(top_srcdir)/m4/intltool.m4 $(top_srcdir)/m4/libtool.m4 \ + $(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \ + $(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \ + $(top_srcdir)/acinclude.m4 $(top_srcdir)/configure.in +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = +CONFIG_CLEAN_VPATH_FILES = +AM_V_GEN = $(am__v_GEN_$(V)) +am__v_GEN_ = $(am__v_GEN_$(AM_DEFAULT_VERBOSITY)) +am__v_GEN_0 = @echo " GEN " $@; +AM_V_at = $(am__v_at_$(V)) +am__v_at_ = $(am__v_at_$(AM_DEFAULT_VERBOSITY)) +am__v_at_0 = @ +SOURCES = +DIST_SOURCES = +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +ACLOCAL_AMFLAGS = @ACLOCAL_AMFLAGS@ +ALL_LINGUAS = @ALL_LINGUAS@ +AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ +AR = @AR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CATALOGS = @CATALOGS@ +CATOBJEXT = @CATOBJEXT@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +COMPRESS_EXT = @COMPRESS_EXT@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CYGPATH_W = @CYGPATH_W@ +DATADIR = @DATADIR@ +DATADIRNAME = @DATADIRNAME@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DISABLE_DEPRECATED = @DISABLE_DEPRECATED@ +DLLTOOL = @DLLTOOL@ +DSYMUTIL = @DSYMUTIL@ +DUMPBIN = @DUMPBIN@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +FGREP = @FGREP@ +GETTEXT_PACKAGE = @GETTEXT_PACKAGE@ +GLADEDIR = @GLADEDIR@ +GLIB_CFLAGS = @GLIB_CFLAGS@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GLIB_LIBS = @GLIB_LIBS@ +GLIB_MKENUMS = @GLIB_MKENUMS@ +GMOFILES = @GMOFILES@ +GMSGFMT = @GMSGFMT@ +GOBJECT_QUERY = @GOBJECT_QUERY@ +GREP = @GREP@ +GTKDOC_CHECK = @GTKDOC_CHECK@ +GTKDOC_MKPDF = @GTKDOC_MKPDF@ +GTKDOC_REBASE = @GTKDOC_REBASE@ +GTK_CFLAGS = @GTK_CFLAGS@ +GTK_LIBS = @GTK_LIBS@ +HTML_DIR = @HTML_DIR@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +INSTOBJEXT = @INSTOBJEXT@ +INTLLIBS = @INTLLIBS@ +INTLTOOL_EXTRACT = @INTLTOOL_EXTRACT@ +INTLTOOL_MERGE = @INTLTOOL_MERGE@ +INTLTOOL_PERL = @INTLTOOL_PERL@ +INTLTOOL_UPDATE = @INTLTOOL_UPDATE@ +LD = @LD@ +LDFLAGS = @LDFLAGS@ +LIBDIR = @LIBDIR@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LIBSOUP_CFLAGS = @LIBSOUP_CFLAGS@ +LIBSOUP_LIBS = @LIBSOUP_LIBS@ +LIBSOUP_MATE_CFLAGS = @LIBSOUP_MATE_CFLAGS@ +LIBSOUP_MATE_LIBS = @LIBSOUP_MATE_LIBS@ +LIBTOOL = @LIBTOOL@ +LIBXML_CFLAGS = @LIBXML_CFLAGS@ +LIBXML_LIBS = @LIBXML_LIBS@ +LIPO = @LIPO@ +LN_S = @LN_S@ +LTLIBOBJS = @LTLIBOBJS@ +LT_VERSION = @LT_VERSION@ +MAINT = @MAINT@ +MAKEINFO = @MAKEINFO@ +MANIFEST_TOOL = @MANIFEST_TOOL@ +MATECONFTOOL = @MATECONFTOOL@ +MATECONF_CFLAGS = @MATECONF_CFLAGS@ +MATECONF_LIBS = @MATECONF_LIBS@ +MATECONF_SCHEMA_CONFIG_SOURCE = @MATECONF_SCHEMA_CONFIG_SOURCE@ +MATECONF_SCHEMA_FILE_DIR = @MATECONF_SCHEMA_FILE_DIR@ +MKDIR_P = @MKDIR_P@ +MKINSTALLDIRS = @MKINSTALLDIRS@ +MSGFMT = @MSGFMT@ +MSGFMT_OPTS = @MSGFMT_OPTS@ +MSGMERGE = @MSGMERGE@ +NM = @NM@ +NMEDIT = @NMEDIT@ +OBJDUMP = @OBJDUMP@ +OBJEXT = @OBJEXT@ +OTOOL = @OTOOL@ +OTOOL64 = @OTOOL64@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PKG_CONFIG = @PKG_CONFIG@ +PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ +PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ +POFILES = @POFILES@ +POSUB = @POSUB@ +PO_IN_DATADIR_FALSE = @PO_IN_DATADIR_FALSE@ +PO_IN_DATADIR_TRUE = @PO_IN_DATADIR_TRUE@ +PYGOBJECT_CFLAGS = @PYGOBJECT_CFLAGS@ +PYGOBJECT_LIBS = @PYGOBJECT_LIBS@ +PYGTK_DEFS = @PYGTK_DEFS@ +PYTHON = @PYTHON@ +PYTHONDIR = @PYTHONDIR@ +PYTHON_EXEC_PREFIX = @PYTHON_EXEC_PREFIX@ +PYTHON_INCLUDES = @PYTHON_INCLUDES@ +PYTHON_PLATFORM = @PYTHON_PLATFORM@ +PYTHON_PREFIX = @PYTHON_PREFIX@ +PYTHON_VERSION = @PYTHON_VERSION@ +RANLIB = @RANLIB@ +REGEX_LIBS = @REGEX_LIBS@ +SED = @SED@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +USE_NLS = @USE_NLS@ +VERSION = @VERSION@ +WARN_CFLAGS = @WARN_CFLAGS@ +XGETTEXT = @XGETTEXT@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_AR = @ac_ct_AR@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +pkgpyexecdir = @pkgpyexecdir@ +pkgpythondir = @pkgpythondir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +pyexecdir = @pyexecdir@ +pythondir = @pythondir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ + +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 + +# The name of the module, e.g. 'glib'. +DOC_MODULE = libmateweather + +# Uncomment for versioned docs and specify the version of the module, e.g. '2'. +#DOC_MODULE_VERSION=2 + +# The top-level SGML file. You can change this if you want to. +DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting the functions and macros. +# e.g. DOC_SOURCE_DIR=../../../gtk +DOC_SOURCE_DIR = ../libmateweather + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS = + +# Extra options to supply to gtkdoc-scan +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS = --deprecated-guards="MATEWEATHER_DISABLE_DEPRECATED" + +# Extra options to supply to gtkdoc-mkdb. +# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml +MKDB_OPTIONS = --sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-mktmpl +# e.g. MKTMPL_OPTIONS=--only-section-tmpl +MKTMPL_OPTIONS = + +# Extra options to supply to gtkdoc-mkhtml +MKHTML_OPTIONS = + +# Extra options to supply to gtkdoc-fixref. Not normally needed. +# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +FIXXREF_OPTIONS = + +# Used for dependencies. The docs will be rebuilt if any of these change. +# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h +# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c +HFILE_GLOB = $(top_srcdir)/libmateweather/*.h +CFILE_GLOB = $(top_srcdir)/libmateweather/*.c + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES = mateweather-enum-types.h mateweather-win32.h parser.h weather-priv.h + +# Images to copy into HTML directory. +# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png +HTML_IMAGES = + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +# e.g. content_files=running.sgml building.sgml changes-2.0.sgml +content_files = + +# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded +# These files must be listed here *and* in content_files +# e.g. expand_content_files=running.sgml +expand_content_files = + +# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. +# Only needed if you are using gtkdoc-scangobj to dynamically query widget +# signals and properties. +# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +GTKDOC_CFLAGS = -I$(top_srcdir) $(GTK_CFLAGS) $(LIBXML_CFLAGS) $(LIBSOUP_CFLAGS) $(MATECONF_CFLAGS) -DMATEWEATHER_I_KNOW_THIS_IS_UNSTABLE +GTKDOC_LIBS = $(top_builddir)/libmateweather/libmateweather.la $(GTK_LIBS) $(LIBXML_LIBS) $(LIBSOUP_LIBS) $(MATECONF_LIBS) + +# This includes the standard gtk-doc make rules, copied by gtkdocize. + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST = missing-gtk-doc +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(top_srcdir)/gtk-doc.make $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu doc/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --gnu doc/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-am +all-am: Makefile +installdirs: +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + `test -z '$(STRIP)' || \ + echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-am + +clean-am: clean-generic clean-libtool mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic + +dvi: dvi-am + +dvi-am: + +html: html-am + +html-am: + +info: info-am + +info-am: + +install-data-am: + +install-dvi: install-dvi-am + +install-dvi-am: + +install-exec-am: + +install-html: install-html-am + +install-html-am: + +install-info: install-info-am + +install-info-am: + +install-man: + +install-pdf: install-pdf-am + +install-pdf-am: + +install-ps: install-ps-am + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: + +.MAKE: install-am install-strip + +.PHONY: all all-am check check-am clean clean-generic clean-libtool \ + distclean distclean-generic distclean-libtool distdir dvi \ + dvi-am html html-am info info-am install install-am \ + install-data install-data-am install-dvi install-dvi-am \ + install-exec install-exec-am install-html install-html-am \ + install-info install-info-am install-man install-pdf \ + install-pdf-am install-ps install-ps-am install-strip \ + installcheck installcheck-am installdirs maintainer-clean \ + maintainer-clean-generic mostlyclean mostlyclean-generic \ + mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am + + +# Files not to distribute +# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types +# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt +#DISTCLEANFILES += + +# Comment this out if you want your docs-status tested during 'make check' +#TESTS = $(GTKDOC_CHECK) + +-include $(top_srcdir)/git.mk + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/doc/html/MateWeatherLocationEntry.html b/doc/html/MateWeatherLocationEntry.html new file mode 100644 index 0000000..60c6c40 --- /dev/null +++ b/doc/html/MateWeatherLocationEntry.html @@ -0,0 +1,226 @@ + + + + +MateWeatherLocationEntry + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MateWeatherLocationEntry

+

MateWeatherLocationEntry

+
+ +
+

Object Hierarchy

+
+  GObject
+   +----GInitiallyUnowned
+         +----GtkObject
+               +----GtkWidget
+                     +----GtkEntry
+                           +----MateWeatherLocationEntry
+
+
+
+

Implemented Interfaces

+

+MateWeatherLocationEntry implements + AtkImplementorIface, GtkBuildable, GtkEditable and GtkCellEditable.

+
+
+

Properties

+
+  "location"                 gpointer              : Read / Write
+  "top"                      gpointer              : Write / Construct Only
+
+
+
+

Description

+

+

+
+
+

Details

+
+

MateWeatherLocationEntry

+
typedef struct _MateWeatherLocationEntry MateWeatherLocationEntry;
+

+A subclass of GtkEntry that provides autocompletion on +MateWeatherLocations

+
+
+
+

mateweather_location_entry_new ()

+
GtkWidget *         mateweather_location_entry_new         (MateWeatherLocation *top);
+

+Creates a new MateWeatherLocationEntry. +

+

+top will normally be a location returned from +mateweather_location_new_world(), but you can create an entry that +only accepts a smaller set of locations if you want.

+
++ + + + + + + + + + +

top :

the top-level location for the entry. +

Returns :

the new MateWeatherLocationEntry +
+
+
+
+

mateweather_location_entry_set_location ()

+
void                mateweather_location_entry_set_location
+                                                        (MateWeatherLocationEntry *entry,
+                                                         MateWeatherLocation *loc);
+

+Sets entry's location to loc, and updates the text of the +entry accordingly.

+
++ + + + + + + + + + +

entry :

a MateWeatherLocationEntry +

loc :

allow-none. allow-none.
+
+
+
+

mateweather_location_entry_get_location ()

+
MateWeatherLocation *  mateweather_location_entry_get_location
+                                                        (MateWeatherLocationEntry *entry);
+

+Gets the location that was set by a previous call to +mateweather_location_entry_set_location() or was selected by the user.

+
++ + + + + + + + + + +

entry :

a MateWeatherLocationEntry +

Returns :

transfer full) (allow-none. transfer full. allow-none.
+
+
+
+

mateweather_location_entry_set_city ()

+
gboolean            mateweather_location_entry_set_city    (MateWeatherLocationEntry *entry,
+                                                         const char *city_name,
+                                                         const char *code);
+

+Sets entry's location to a city with the given code, and given +city_name, if non-NULL. If there is no matching city, sets +entry's location to NULL.

+
++ + + + + + + + + + + + + + + + + + +

entry :

a MateWeatherLocationEntry +

city_name :

the city name, or NULL. allow-none.

code :

the METAR station code +

Returns :

TRUE if entry's location could be set to a matching city, +FALSE otherwise. +
+
+
+
+

Property Details

+
+

The "location" property

+
  "location"                 gpointer              : Read / Write
+

The selected MateWeatherLocation.

+
+
+
+

The "top" property

+
  "top"                      gpointer              : Write / Construct Only
+

The MateWeatherLocation whose children will be used to fill in the entry.

+
+
+
+ + + \ No newline at end of file diff --git a/doc/html/MateWeatherTimezoneMenu.html b/doc/html/MateWeatherTimezoneMenu.html new file mode 100644 index 0000000..6af817d --- /dev/null +++ b/doc/html/MateWeatherTimezoneMenu.html @@ -0,0 +1,184 @@ + + + + +MateWeatherTimezoneMenu + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MateWeatherTimezoneMenu

+

MateWeatherTimezoneMenu

+
+ +
+

Object Hierarchy

+
+  GObject
+   +----GInitiallyUnowned
+         +----GtkObject
+               +----GtkWidget
+                     +----GtkContainer
+                           +----GtkBin
+                                 +----GtkComboBox
+                                       +----MateWeatherTimezoneMenu
+
+
+
+

Implemented Interfaces

+

+MateWeatherTimezoneMenu implements + AtkImplementorIface, GtkBuildable, GtkCellLayout and GtkCellEditable.

+
+
+

Properties

+
+  "top"                      gpointer              : Write / Construct Only
+  "tzid"                     gchar*                : Read / Write
+
+
+
+

Description

+

+

+
+
+

Details

+
+

MateWeatherTimezoneMenu

+
typedef struct _MateWeatherTimezoneMenu MateWeatherTimezoneMenu;
+

+A GtkComboBox subclass for choosing a MateWeatherTimezone

+
+
+
+

mateweather_timezone_menu_new ()

+
GtkWidget *         mateweather_timezone_menu_new          (MateWeatherLocation *top);
+

+Creates a new MateWeatherTimezoneMenu. +

+

+top will normally be a location returned from +mateweather_location_new_world(), but you can create a menu that +contains the timezones from a smaller set of locations if you want.

+
++ + + + + + + + + + +

top :

the top-level location for the menu. +

Returns :

the new MateWeatherTimezoneMenu +
+
+
+
+

mateweather_timezone_menu_set_tzid ()

+
void                mateweather_timezone_menu_set_tzid     (MateWeatherTimezoneMenu *menu,
+                                                         const char *tzid);
+

+Sets menu to the given tzid. If tzid is NULL, sets menu to +"Unknown".

+
++ + + + + + + + + + +

menu :

a MateWeatherTimezoneMenu +

tzid :

a tzdata id (eg, "America/New_York"). allow-none.
+
+
+
+

mateweather_timezone_menu_get_tzid ()

+
const char *        mateweather_timezone_menu_get_tzid     (MateWeatherTimezoneMenu *menu);
+

+Gets menu's timezone id.

+
++ + + + + + + + + + +

menu :

a MateWeatherTimezoneMenu +

Returns :

allow-none. allow-none.
+
+
+
+

Property Details

+
+

The "top" property

+
  "top"                      gpointer              : Write / Construct Only
+

The MateWeatherLocation whose children will be used to fill in the menu.

+
+
+
+

The "tzid" property

+
  "tzid"                     gchar*                : Read / Write
+

The selected TZID.

+

Default value: NULL

+
+
+
+ + + \ No newline at end of file diff --git a/doc/html/ch01.html b/doc/html/ch01.html new file mode 100644 index 0000000..4cbae3c --- /dev/null +++ b/doc/html/ch01.html @@ -0,0 +1,56 @@ + + + + +[Insert title here] + + + + + + + + + + + + + + + + +
+

+[Insert title here]

+ +
+ + + \ No newline at end of file diff --git a/doc/html/home.png b/doc/html/home.png new file mode 100644 index 0000000..1700361 Binary files /dev/null and b/doc/html/home.png differ diff --git a/doc/html/index.html b/doc/html/index.html new file mode 100644 index 0000000..5860012 --- /dev/null +++ b/doc/html/index.html @@ -0,0 +1,59 @@ + + + + +libmateweather Reference Manual + + + + + + + +
+
+
+
+

+ for libmateweather [VERSION] + The latest version of this documentation can be found on-line at + http://[SERVER]/libmateweather/. +

+
+
+
+ +
+ + + \ No newline at end of file diff --git a/doc/html/index.sgml b/doc/html/index.sgml new file mode 100644 index 0000000..eb85662 --- /dev/null +++ b/doc/html/index.sgml @@ -0,0 +1,180 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/html/left.png b/doc/html/left.png new file mode 100644 index 0000000..2d05b3d Binary files /dev/null and b/doc/html/left.png differ diff --git a/doc/html/libmateweather-mateweather-location.html b/doc/html/libmateweather-mateweather-location.html new file mode 100644 index 0000000..a4653b9 --- /dev/null +++ b/doc/html/libmateweather-mateweather-location.html @@ -0,0 +1,620 @@ + + + + +mateweather-location + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

mateweather-location

+

mateweather-location

+
+
+

Synopsis

+
                    MateWeatherLocation;
+enum                MateWeatherLocationLevel;
+MateWeatherLocation *  mateweather_location_new_world         (gboolean use_regions);
+MateWeatherLocation *  mateweather_location_ref               (MateWeatherLocation *loc);
+void                mateweather_location_unref             (MateWeatherLocation *loc);
+const char *        mateweather_location_get_name          (MateWeatherLocation *loc);
+const char *        mateweather_location_get_sort_name     (MateWeatherLocation *loc);
+MateWeatherLocationLevel  mateweather_location_get_level      (MateWeatherLocation *loc);
+MateWeatherLocation *  mateweather_location_get_parent        (MateWeatherLocation *loc);
+MateWeatherLocation ** mateweather_location_get_children      (MateWeatherLocation *loc);
+void                mateweather_location_free_children     (MateWeatherLocation *loc,
+                                                         MateWeatherLocation **children);
+gboolean            mateweather_location_has_coords        (MateWeatherLocation *loc);
+void                mateweather_location_get_coords        (MateWeatherLocation *loc,
+                                                         double *latitude,
+                                                         double *longitude);
+double              mateweather_location_get_distance      (MateWeatherLocation *loc,
+                                                         MateWeatherLocation *loc2);
+const char *        mateweather_location_get_country       (MateWeatherLocation *loc);
+MateWeatherTimezone *  mateweather_location_get_timezone      (MateWeatherLocation *loc);
+MateWeatherTimezone ** mateweather_location_get_timezones     (MateWeatherLocation *loc);
+void                mateweather_location_free_timezones    (MateWeatherLocation *loc,
+                                                         MateWeatherTimezone **zones);
+const char *        mateweather_location_get_code          (MateWeatherLocation *loc);
+char *              mateweather_location_get_city_name     (MateWeatherLocation *loc);
+WeatherInfo *       mateweather_location_get_weather       (MateWeatherLocation *loc);
+
+
+
+

Description

+

+

+
+
+

Details

+
+

MateWeatherLocation

+
typedef struct _MateWeatherLocation MateWeatherLocation;
+

+A MateWeatherLocation represents a "location" of some type known to +libmateweather; anything from a single weather station to the entire +world. See MateWeatherLocationLevel for information about how the +hierarchy of locations works.

+
+
+
+

enum MateWeatherLocationLevel

+
typedef enum { /*< underscore_name=mateweather_location_level >*/
+    MATEWEATHER_LOCATION_WORLD,
+    MATEWEATHER_LOCATION_REGION,
+    MATEWEATHER_LOCATION_COUNTRY,
+    /* ADM1 = first-order administrative division = state/province, etc */
+    MATEWEATHER_LOCATION_ADM1,
+    /* ADM2 = second-order division = county, etc */
+    MATEWEATHER_LOCATION_ADM2,
+    MATEWEATHER_LOCATION_CITY,
+    MATEWEATHER_LOCATION_WEATHER_STATION
+} MateWeatherLocationLevel;
+
+

+The size/scope of a particular MateWeatherLocation. +

+

+Locations form a hierarchy, with a MATEWEATHER_LOCATION_WORLD +location at the top, divided into regions or countries, and so on. +Countries may or may not be divided into "adm1"s, and "adm1"s may +or may not be divided into "adm2"s. A city will have at least one, +and possibly several, weather stations inside it. Weather stations +will never appear outside of cities.

+
++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

MATEWEATHER_LOCATION_WORLD

A location representing the entire world. +

MATEWEATHER_LOCATION_REGION

A location representing a continent or +other top-level region. +

MATEWEATHER_LOCATION_COUNTRY

A location representing a "country" (or +other geographic unit that has an ISO-3166 country code) +

MATEWEATHER_LOCATION_ADM1

A location representing a "first-level +administrative division"; ie, a state, province, or similar +division. +

MATEWEATHER_LOCATION_ADM2

A location representing a subdivision of a +MATEWEATHER_LOCATION_ADM1 location. (Not currently used.) +

MATEWEATHER_LOCATION_CITY

A location representing a city +

MATEWEATHER_LOCATION_WEATHER_STATION

A location representing a +weather station. +
+
+
+
+

mateweather_location_new_world ()

+
MateWeatherLocation *  mateweather_location_new_world         (gboolean use_regions);
+

+Creates a new MateWeatherLocation of type MATEWEATHER_LOCATION_WORLD, +representing a hierarchy containing all of the locations from +Locations.xml. +

+

+If use_regions is TRUE, the immediate children of the returned +location will be MATEWEATHER_LOCATION_REGION nodes, representing the +top-level "regions" of Locations.xml (the continents and a few +other divisions), and the country-level nodes will be the children +of the regions. If use_regions is FALSE, the regions will be +skipped, and the children of the returned location will be the +MATEWEATHER_LOCATION_COUNTRY nodes.

+
++ + + + + + + + + + +

use_regions :

whether or not to divide the world into regions +

Returns :

allow-none. allow-none.
+
+
+
+

mateweather_location_ref ()

+
MateWeatherLocation *  mateweather_location_ref               (MateWeatherLocation *loc);
+

+Adds 1 to loc's reference count.

+
++ + + + + + + + + + +

loc :

a MateWeatherLocation +

Returns :

loc +
+
+
+
+

mateweather_location_unref ()

+
void                mateweather_location_unref             (MateWeatherLocation *loc);
+

+Subtracts 1 from loc's reference count, and frees it if the +reference count reaches 0.

+
++ + + + +

loc :

a MateWeatherLocation +
+
+
+
+

mateweather_location_get_name ()

+
const char *        mateweather_location_get_name          (MateWeatherLocation *loc);
+

+Gets loc's name, localized into the current language. +

+

+Note that MATEWEATHER_LOCATION_WEATHER_STATION nodes are not +localized, and so the name returned for those nodes will always be +in English, and should therefore not be displayed to the user. +(FIXME: should we just not return a name?)

+
++ + + + + + + + + + +

loc :

a MateWeatherLocation +

Returns :

loc's name +
+
+
+
+

mateweather_location_get_sort_name ()

+
const char *        mateweather_location_get_sort_name     (MateWeatherLocation *loc);
+

+Gets loc's "sort name", which is the name after having +g_utf8_normalize() (with G_NORMALIZE_ALL) and g_utf8_casefold() +called on it. You can use this to sort locations, or to comparing +user input against a location name.

+
++ + + + + + + + + + +

loc :

a MateWeatherLocation +

Returns :

loc's sort name +
+
+
+
+

mateweather_location_get_level ()

+
MateWeatherLocationLevel  mateweather_location_get_level      (MateWeatherLocation *loc);
+

+Gets loc's level, from MATEWEATHER_LOCATION_WORLD, to +MATEWEATHER_LOCATION_WEATHER_STATION.

+
++ + + + + + + + + + +

loc :

a MateWeatherLocation +

Returns :

loc's level +
+
+
+
+

mateweather_location_get_parent ()

+
MateWeatherLocation *  mateweather_location_get_parent        (MateWeatherLocation *loc);
+

+Gets loc's parent location.

+
++ + + + + + + + + + +

loc :

a MateWeatherLocation +

Returns :

transfer none) (allow-none. transfer none. allow-none.
+
+
+
+

mateweather_location_get_children ()

+
MateWeatherLocation ** mateweather_location_get_children      (MateWeatherLocation *loc);
+

+Gets an array of loc's children; this is owned by loc and will +not remain valid if loc is freed.

+
++ + + + + + + + + + +

loc :

a MateWeatherLocation +

Returns :

transfer none) (array zero-terminated=1. transfer none. array zero-terminated=1.
+
+
+
+

mateweather_location_free_children ()

+
void                mateweather_location_free_children     (MateWeatherLocation *loc,
+                                                         MateWeatherLocation **children);
+
+

Warning

+

mateweather_location_free_children is deprecated and should not be used in newly-written code. This is a no-op.

+
+

+This is a no-op. Do not use it.

+
++ + + + + + + + + + +

loc :

a MateWeatherLocation +

children :

an array of loc's children +
+
+
+
+

mateweather_location_has_coords ()

+
gboolean            mateweather_location_has_coords        (MateWeatherLocation *loc);
+

+Checks if loc has valid latitude and longitude.

+
++ + + + + + + + + + +

loc :

a MateWeatherLocation +

Returns :

TRUE if loc has valid latitude and longitude. +
+
+
+
+

mateweather_location_get_coords ()

+
void                mateweather_location_get_coords        (MateWeatherLocation *loc,
+                                                         double *latitude,
+                                                         double *longitude);
+

+Gets loc's coordinates; you must check +mateweather_location_has_coords() before calling this.

+
++ + + + + + + + + + + + + + +

loc :

a MateWeatherLocation +

latitude :

on return will contain loc's latitude. out.

longitude :

on return will contain loc's longitude. out.
+
+
+
+

mateweather_location_get_distance ()

+
double              mateweather_location_get_distance      (MateWeatherLocation *loc,
+                                                         MateWeatherLocation *loc2);
+

+Determines the distance in kilometers between loc and loc2.

+
++ + + + + + + + + + + + + + +

loc :

a MateWeatherLocation +

loc2 :

a second MateWeatherLocation +

Returns :

the distance between loc and loc2. +
+
+
+
+

mateweather_location_get_country ()

+
const char *        mateweather_location_get_country       (MateWeatherLocation *loc);
+

+Gets the ISO 3166 country code of loc (or NULL if loc is a +region- or world-level location)

+
++ + + + + + + + + + +

loc :

a MateWeatherLocation +

Returns :

allow-none. allow-none.
+
+
+
+

mateweather_location_get_timezone ()

+
MateWeatherTimezone *  mateweather_location_get_timezone      (MateWeatherLocation *loc);
+

+Gets the timezone associated with loc, if known. +

+

+The timezone is owned either by loc or by one of its parents. +FIXME.

+
++ + + + + + + + + + +

loc :

a MateWeatherLocation +

Returns :

transfer none) (allow-none. transfer none. allow-none.
+
+
+
+

mateweather_location_get_timezones ()

+
MateWeatherTimezone ** mateweather_location_get_timezones     (MateWeatherLocation *loc);
+

+Gets an array of all timezones associated with any location under +loc. You can use mateweather_location_free_timezones() to free this +array.

+
++ + + + + + + + + + +

loc :

a MateWeatherLocation +

Returns :

transfer full) (array zero-terminated=1. transfer full. array zero-terminated=1.
+
+
+
+

mateweather_location_free_timezones ()

+
void                mateweather_location_free_timezones    (MateWeatherLocation *loc,
+                                                         MateWeatherTimezone **zones);
+

+Frees the array of timezones returned by +mateweather_location_get_timezones().

+
++ + + + + + + + + + +

loc :

a MateWeatherLocation +

zones :

an array returned from mateweather_location_get_timezones() +
+
+
+
+

mateweather_location_get_code ()

+
const char *        mateweather_location_get_code          (MateWeatherLocation *loc);
+

+Gets the METAR station code associated with a +MATEWEATHER_LOCATION_WEATHER_STATION location.

+
++ + + + + + + + + + +

loc :

a MateWeatherLocation +

Returns :

loc's METAR station code, or NULL. allow-none.
+
+
+
+

mateweather_location_get_city_name ()

+
char *              mateweather_location_get_city_name     (MateWeatherLocation *loc);
+

+For a MATEWEATHER_LOCATION_CITY location, this is equivalent to +mateweather_location_get_name(). For a +MATEWEATHER_LOCATION_WEATHER_STATION location, it is equivalent to +calling mateweather_location_get_name() on the location's parent. For +other locations it will return NULL.

+
++ + + + + + + + + + +

loc :

a MateWeatherLocation +

Returns :

(allow-none) loc's city name, or NULL +
+
+
+
+

mateweather_location_get_weather ()

+
WeatherInfo *       mateweather_location_get_weather       (MateWeatherLocation *loc);
+

+Creates a WeatherInfo corresponding to loc; you can use +weather_info_update() to fill it in.

+
++ + + + + + + + + + +

loc :

a MateWeatherLocation +

Returns :

transfer full. transfer full.
+
+
+
+ + + \ No newline at end of file diff --git a/doc/html/libmateweather-mateweather-mateconf.html b/doc/html/libmateweather-mateweather-mateconf.html new file mode 100644 index 0000000..d0becc8 --- /dev/null +++ b/doc/html/libmateweather-mateweather-mateconf.html @@ -0,0 +1,405 @@ + + + + +mateweather-mateconf + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

mateweather-mateconf

+

mateweather-mateconf

+
+
+

Synopsis

+
                    MateWeatherMateConf;
+MateWeatherMateConf *     mateweather_mateconf_new                  (const char *prefix);
+void                mateweather_mateconf_free                 (MateWeatherMateConf *ctx);
+MateConfClient *       mateweather_mateconf_get_client           (MateWeatherMateConf *ctx);
+WeatherLocation *   mateweather_mateconf_get_location         (MateWeatherMateConf *ctx);
+gchar *             mateweather_mateconf_get_full_key         (MateWeatherMateConf *ctx,
+                                                         const gchar *key);
+void                mateweather_mateconf_set_bool             (MateWeatherMateConf *ctx,
+                                                         const gchar *key,
+                                                         gboolean the_bool,
+                                                         GError **opt_error);
+void                mateweather_mateconf_set_int              (MateWeatherMateConf *ctx,
+                                                         const gchar *key,
+                                                         gint the_int,
+                                                         GError **opt_error);
+void                mateweather_mateconf_set_string           (MateWeatherMateConf *ctx,
+                                                         const gchar *key,
+                                                         const gchar *the_string,
+                                                         GError **opt_error);
+gboolean            mateweather_mateconf_get_bool             (MateWeatherMateConf *ctx,
+                                                         const gchar *key,
+                                                         GError **opt_error);
+gint                mateweather_mateconf_get_int              (MateWeatherMateConf *ctx,
+                                                         const gchar *key,
+                                                         GError **opt_error);
+gchar *             mateweather_mateconf_get_string           (MateWeatherMateConf *ctx,
+                                                         const gchar *key,
+                                                         GError **opt_error);
+
+
+
+

Description

+

+

+
+
+

Details

+
+

MateWeatherMateConf

+
typedef struct _MateWeatherMateConf MateWeatherMateConf;
+

+

+
+
+
+

mateweather_mateconf_new ()

+
MateWeatherMateConf *     mateweather_mateconf_new                  (const char *prefix);
+

+

+
++ + + + + + + + + + +

prefix :

+

Returns :

+
+
+
+
+

mateweather_mateconf_free ()

+
void                mateweather_mateconf_free                 (MateWeatherMateConf *ctx);
+

+

+
++ + + + +

ctx :

+
+
+
+
+

mateweather_mateconf_get_client ()

+
MateConfClient *       mateweather_mateconf_get_client           (MateWeatherMateConf *ctx);
+

+

+
++ + + + + + + + + + +

ctx :

+

Returns :

+
+
+
+
+

mateweather_mateconf_get_location ()

+
WeatherLocation *   mateweather_mateconf_get_location         (MateWeatherMateConf *ctx);
+

+

+
++ + + + + + + + + + +

ctx :

+

Returns :

+
+
+
+
+

mateweather_mateconf_get_full_key ()

+
gchar *             mateweather_mateconf_get_full_key         (MateWeatherMateConf *ctx,
+                                                         const gchar *key);
+

+

+
++ + + + + + + + + + + + + + +

ctx :

+

key :

+

Returns :

+
+
+
+
+

mateweather_mateconf_set_bool ()

+
void                mateweather_mateconf_set_bool             (MateWeatherMateConf *ctx,
+                                                         const gchar *key,
+                                                         gboolean the_bool,
+                                                         GError **opt_error);
+

+

+
++ + + + + + + + + + + + + + + + + + +

ctx :

+

key :

+

the_bool :

+

opt_error :

+
+
+
+
+

mateweather_mateconf_set_int ()

+
void                mateweather_mateconf_set_int              (MateWeatherMateConf *ctx,
+                                                         const gchar *key,
+                                                         gint the_int,
+                                                         GError **opt_error);
+

+

+
++ + + + + + + + + + + + + + + + + + +

ctx :

+

key :

+

the_int :

+

opt_error :

+
+
+
+
+

mateweather_mateconf_set_string ()

+
void                mateweather_mateconf_set_string           (MateWeatherMateConf *ctx,
+                                                         const gchar *key,
+                                                         const gchar *the_string,
+                                                         GError **opt_error);
+

+

+
++ + + + + + + + + + + + + + + + + + +

ctx :

+

key :

+

the_string :

+

opt_error :

+
+
+
+
+

mateweather_mateconf_get_bool ()

+
gboolean            mateweather_mateconf_get_bool             (MateWeatherMateConf *ctx,
+                                                         const gchar *key,
+                                                         GError **opt_error);
+

+

+
++ + + + + + + + + + + + + + + + + + +

ctx :

+

key :

+

opt_error :

+

Returns :

+
+
+
+
+

mateweather_mateconf_get_int ()

+
gint                mateweather_mateconf_get_int              (MateWeatherMateConf *ctx,
+                                                         const gchar *key,
+                                                         GError **opt_error);
+

+

+
++ + + + + + + + + + + + + + + + + + +

ctx :

+

key :

+

opt_error :

+

Returns :

+
+
+
+
+

mateweather_mateconf_get_string ()

+
gchar *             mateweather_mateconf_get_string           (MateWeatherMateConf *ctx,
+                                                         const gchar *key,
+                                                         GError **opt_error);
+

+

+
++ + + + + + + + + + + + + + + + + + +

ctx :

+

key :

+

opt_error :

+

Returns :

+
+
+
+
+ + + \ No newline at end of file diff --git a/doc/html/libmateweather-mateweather-prefs.html b/doc/html/libmateweather-mateweather-prefs.html new file mode 100644 index 0000000..55499c1 --- /dev/null +++ b/doc/html/libmateweather-mateweather-prefs.html @@ -0,0 +1,396 @@ + + + + +mateweather-prefs + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

mateweather-prefs

+

mateweather-prefs

+
+ +
+

Description

+

+

+
+
+

Details

+
+

MATECONF_TEMP_UNIT

+
#define MATECONF_TEMP_UNIT     "temperature_unit"
+
+

+

+
+
+
+

MATECONF_SPEED_UNIT

+
#define MATECONF_SPEED_UNIT    "speed_unit"
+
+

+

+
+
+
+

MATECONF_PRESSURE_UNIT

+
#define MATECONF_PRESSURE_UNIT "pressure_unit"
+
+

+

+
+
+
+

MATECONF_DISTANCE_UNIT

+
#define MATECONF_DISTANCE_UNIT "distance_unit"
+
+

+

+
+
+
+

MateWeatherPrefs

+
typedef struct {
+    WeatherLocation *location;
+    gint update_interval;  /* in seconds */
+    gboolean update_enabled;
+    gboolean detailed;
+    gboolean radar_enabled;
+    gboolean use_custom_radar_url;
+    gchar *radar;
+
+    TempUnit     temperature_unit;
+    gboolean     use_temperature_default;
+    SpeedUnit    speed_unit;
+    gboolean     use_speed_default;
+    PressureUnit pressure_unit;
+    gboolean     use_pressure_default;
+    DistanceUnit distance_unit;
+    gboolean     use_distance_default;
+} MateWeatherPrefs;
+
+

+

+
+
+
+

mateweather_prefs_load ()

+
void                mateweather_prefs_load                 (MateWeatherPrefs *prefs,
+                                                         MateWeatherMateConf *ctx);
+

+

+
++ + + + + + + + + + +

prefs :

+

ctx :

+
+
+
+
+

mateweather_prefs_temp_enum_to_string ()

+
const char *        mateweather_prefs_temp_enum_to_string  (TempUnit temp);
+

+

+
++ + + + + + + + + + +

temp :

+

Returns :

+
+
+
+
+

mateweather_prefs_speed_enum_to_string ()

+
const char *        mateweather_prefs_speed_enum_to_string (SpeedUnit speed);
+

+

+
++ + + + + + + + + + +

speed :

+

Returns :

+
+
+
+
+

mateweather_prefs_pressure_enum_to_string ()

+
const char *        mateweather_prefs_pressure_enum_to_string
+                                                        (PressureUnit pressure);
+

+

+
++ + + + + + + + + + +

pressure :

+

Returns :

+
+
+
+
+

mateweather_prefs_distance_enum_to_string ()

+
const char *        mateweather_prefs_distance_enum_to_string
+                                                        (DistanceUnit distance);
+

+

+
++ + + + + + + + + + +

distance :

+

Returns :

+
+
+
+
+

mateweather_prefs_parse_temperature ()

+
TempUnit            mateweather_prefs_parse_temperature    (const char *str,
+                                                         gboolean *is_default);
+

+

+
++ + + + + + + + + + + + + + +

str :

+

is_default :

+

Returns :

+
+
+
+
+

mateweather_prefs_parse_speed ()

+
SpeedUnit           mateweather_prefs_parse_speed          (const char *str,
+                                                         gboolean *is_default);
+

+

+
++ + + + + + + + + + + + + + +

str :

+

is_default :

+

Returns :

+
+
+
+
+

mateweather_prefs_get_temp_display_name ()

+
const char *        mateweather_prefs_get_temp_display_name
+                                                        (TempUnit temp);
+

+

+
++ + + + + + + + + + +

temp :

+

Returns :

+
+
+
+
+

mateweather_prefs_get_speed_display_name ()

+
const char *        mateweather_prefs_get_speed_display_name
+                                                        (SpeedUnit speed);
+

+

+
++ + + + + + + + + + +

speed :

+

Returns :

+
+
+
+
+

mateweather_prefs_get_pressure_display_name ()

+
const char *        mateweather_prefs_get_pressure_display_name
+                                                        (PressureUnit pressure);
+

+

+
++ + + + + + + + + + +

pressure :

+

Returns :

+
+
+
+
+

mateweather_prefs_get_distance_display_name ()

+
const char *        mateweather_prefs_get_distance_display_name
+                                                        (DistanceUnit distance);
+

+

+
++ + + + + + + + + + +

distance :

+

Returns :

+
+
+
+
+ + + \ No newline at end of file diff --git a/doc/html/libmateweather-mateweather-timezone.html b/doc/html/libmateweather-mateweather-timezone.html new file mode 100644 index 0000000..785eddf --- /dev/null +++ b/doc/html/libmateweather-mateweather-timezone.html @@ -0,0 +1,231 @@ + + + + +mateweather-timezone + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

mateweather-timezone

+

mateweather-timezone

+
+ +
+

Description

+

+

+
+
+

Details

+
+

MateWeatherTimezone

+
typedef struct _MateWeatherTimezone MateWeatherTimezone;
+

+A timezone. +

+

+There are no public methods for creating timezones; they can only +be created by calling mateweather_location_new_world() to parse +Locations.xml, and then calling various MateWeatherLocation methods +to extract relevant timezones from the location hierarchy.

+
+
+
+

mateweather_timezone_get_name ()

+
const char *        mateweather_timezone_get_name          (MateWeatherTimezone *zone);
+

+Gets zone's name; a translated, user-presentable string. +

+

+Note that the returned name might not be unique among timezones, +and may not make sense to the user unless it is presented along +with the timezone's country's name (or in some context where the +country is obvious).

+
++ + + + + + + + + + +

zone :

a MateWeatherTimezone +

Returns :

zone's name +
+
+
+
+

mateweather_timezone_get_tzid ()

+
const char *        mateweather_timezone_get_tzid          (MateWeatherTimezone *zone);
+

+Gets zone's tzdata identifier, eg "America/New_York".

+
++ + + + + + + + + + +

zone :

a MateWeatherTimezone +

Returns :

zone's tzid +
+
+
+
+

mateweather_timezone_get_offset ()

+
int                 mateweather_timezone_get_offset        (MateWeatherTimezone *zone);
+

+Gets zone's standard offset from UTC, in minutes. Eg, a value of +120 would indicate "GMT+2".

+
++ + + + + + + + + + +

zone :

a MateWeatherTimezone +

Returns :

zone's standard offset, in minutes +
+
+
+
+

mateweather_timezone_has_dst ()

+
gboolean            mateweather_timezone_has_dst           (MateWeatherTimezone *zone);
+

+Checks if zone observes daylight/summer time for part of the year.

+
++ + + + + + + + + + +

zone :

a MateWeatherTimezone +

Returns :

TRUE if zone observes daylight/summer time. +
+
+
+
+

mateweather_timezone_get_dst_offset ()

+
int                 mateweather_timezone_get_dst_offset    (MateWeatherTimezone *zone);
+

+Gets zone's daylight/summer time offset from UTC, in minutes. Eg, +a value of 120 would indicate "GMT+2". This is only meaningful if +mateweather_timezone_has_dst() returns TRUE.

+
++ + + + + + + + + + +

zone :

a MateWeatherTimezone +

Returns :

zone's daylight/summer time offset, in minutes +
+
+
+
+

mateweather_timezone_ref ()

+
MateWeatherTimezone *  mateweather_timezone_ref               (MateWeatherTimezone *zone);
+

+Adds 1 to zone's reference count.

+
++ + + + + + + + + + +

zone :

a MateWeatherTimezone +

Returns :

zone +
+
+
+
+

mateweather_timezone_unref ()

+
void                mateweather_timezone_unref             (MateWeatherTimezone *zone);
+

+Subtracts 1 from zone's reference count and frees it if it reaches 0.

+
++ + + + +

zone :

a MateWeatherTimezone +
+
+
+
+ + + \ No newline at end of file diff --git a/doc/html/libmateweather-mateweather-xml.html b/doc/html/libmateweather-mateweather-xml.html new file mode 100644 index 0000000..8419749 --- /dev/null +++ b/doc/html/libmateweather-mateweather-xml.html @@ -0,0 +1,70 @@ + + + + +mateweather-xml + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

mateweather-xml

+

mateweather-xml

+
+
+

Synopsis

+
GtkTreeModel *      mateweather_xml_load_locations         (void);
+
+
+
+

Description

+

+

+
+
+

Details

+
+

mateweather_xml_load_locations ()

+
GtkTreeModel *      mateweather_xml_load_locations         (void);
+

+

+
++ + + + +

Returns :

+
+
+
+
+ + + \ No newline at end of file diff --git a/doc/html/libmateweather-weather.html b/doc/html/libmateweather-weather.html new file mode 100644 index 0000000..2c81958 --- /dev/null +++ b/doc/html/libmateweather-weather.html @@ -0,0 +1,1639 @@ + + + + +weather + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

weather

+

weather

+
+
+

Synopsis

+
                    WeatherLocation;
+WeatherLocation *   weather_location_new                (const gchar *trans_name,
+                                                         const gchar *code,
+                                                         const gchar *zone,
+                                                         const gchar *radar,
+                                                         const gchar *coordinates,
+                                                         const gchar *country_code,
+                                                         const gchar *tz_hint);
+WeatherLocation *   weather_location_clone              (const WeatherLocation *location);
+void                weather_location_free               (WeatherLocation *location);
+gboolean            weather_location_equal              (const WeatherLocation *location1,
+                                                         const WeatherLocation *location2);
+enum                WeatherForecastType;
+enum                TempUnit;
+enum                SpeedUnit;
+enum                PressureUnit;
+enum                DistanceUnit;
+                    WeatherPrefs;
+                    WeatherInfo;
+void                (*WeatherInfoFunc)                  (WeatherInfo *info,
+                                                         gpointer data);
+#define             weather_info_new                    (location,
+                                                         prefs,
+                                                         cb,
+                                                         data)
+#define             weather_info_update                 (info,
+                                                         prefs,
+                                                         cb,
+                                                         data)
+void                weather_info_abort                  (WeatherInfo *info);
+WeatherInfo *       weather_info_clone                  (const WeatherInfo *info);
+void                weather_info_free                   (WeatherInfo *info);
+gboolean            weather_info_is_valid               (WeatherInfo *info);
+gboolean            weather_info_network_error          (WeatherInfo *info);
+void                weather_info_to_metric              (WeatherInfo *info);
+void                weather_info_to_imperial            (WeatherInfo *info);
+const WeatherLocation * weather_info_get_location       (WeatherInfo *info);
+const gchar *       weather_info_get_location_name      (WeatherInfo *info);
+const gchar *       weather_info_get_update             (WeatherInfo *info);
+const gchar *       weather_info_get_sky                (WeatherInfo *info);
+const gchar *       weather_info_get_conditions         (WeatherInfo *info);
+const gchar *       weather_info_get_temp               (WeatherInfo *info);
+const gchar *       weather_info_get_temp_min           (WeatherInfo *info);
+const gchar *       weather_info_get_temp_max           (WeatherInfo *info);
+const gchar *       weather_info_get_dew                (WeatherInfo *info);
+const gchar *       weather_info_get_humidity           (WeatherInfo *info);
+const gchar *       weather_info_get_wind               (WeatherInfo *info);
+const gchar *       weather_info_get_pressure           (WeatherInfo *info);
+const gchar *       weather_info_get_visibility         (WeatherInfo *info);
+const gchar *       weather_info_get_apparent           (WeatherInfo *info);
+const gchar *       weather_info_get_sunrise            (WeatherInfo *info);
+const gchar *       weather_info_get_sunset             (WeatherInfo *info);
+const gchar *       weather_info_get_forecast           (WeatherInfo *info);
+GSList *            weather_info_get_forecast_list      (WeatherInfo *info);
+GdkPixbufAnimation * weather_info_get_radar             (WeatherInfo *info);
+const gchar *       weather_info_get_temp_summary       (WeatherInfo *info);
+gchar *             weather_info_get_weather_summary    (WeatherInfo *info);
+const gchar *       weather_info_get_icon_name          (WeatherInfo *info);
+gint                weather_info_next_sun_event         (WeatherInfo *info);
+enum                WeatherWindDirection;
+enum                WeatherSky;
+enum                WeatherConditionPhenomenon;
+enum                WeatherConditionQualifier;
+gboolean            weather_info_get_value_update       (WeatherInfo *info,
+                                                         time_t *value);
+gboolean            weather_info_get_value_sky          (WeatherInfo *info,
+                                                         WeatherSky *sky);
+gboolean            weather_info_get_value_conditions   (WeatherInfo *info,
+                                                         WeatherConditionPhenomenon *phenomenon,
+                                                         WeatherConditionQualifier *qualifier);
+gboolean            weather_info_get_value_temp         (WeatherInfo *info,
+                                                         TempUnit unit,
+                                                         gdouble *value);
+gboolean            weather_info_get_value_temp_min     (WeatherInfo *info,
+                                                         TempUnit unit,
+                                                         gdouble *value);
+gboolean            weather_info_get_value_temp_max     (WeatherInfo *info,
+                                                         TempUnit unit,
+                                                         gdouble *value);
+gboolean            weather_info_get_value_dew          (WeatherInfo *info,
+                                                         TempUnit unit,
+                                                         gdouble *value);
+gboolean            weather_info_get_value_apparent     (WeatherInfo *info,
+                                                         TempUnit unit,
+                                                         gdouble *value);
+gboolean            weather_info_get_value_wind         (WeatherInfo *info,
+                                                         SpeedUnit unit,
+                                                         gdouble *speed,
+                                                         WeatherWindDirection *direction);
+gboolean            weather_info_get_value_pressure     (WeatherInfo *info,
+                                                         PressureUnit unit,
+                                                         gdouble *value);
+gboolean            weather_info_get_value_visibility   (WeatherInfo *info,
+                                                         DistanceUnit unit,
+                                                         gdouble *value);
+gboolean            weather_info_get_value_sunrise      (WeatherInfo *info,
+                                                         time_t *value);
+gboolean            weather_info_get_value_sunset       (WeatherInfo *info,
+                                                         time_t *value);
+
+
+
+

Description

+

+

+
+
+

Details

+
+

WeatherLocation

+
typedef struct {
+    gchar *name;
+    gchar *code;
+    gchar *zone;
+    gchar *radar;
+    gboolean zone_valid;
+    gchar *coordinates;
+    gdouble  latitude;
+    gdouble  longitude;
+    gboolean latlon_valid;
+    gchar *country_code;
+    gchar *tz_hint;
+} WeatherLocation;
+
+

+

+
+
+
+

weather_location_new ()

+
WeatherLocation *   weather_location_new                (const gchar *trans_name,
+                                                         const gchar *code,
+                                                         const gchar *zone,
+                                                         const gchar *radar,
+                                                         const gchar *coordinates,
+                                                         const gchar *country_code,
+                                                         const gchar *tz_hint);
+

+

+
++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

trans_name :

+

code :

+

zone :

+

radar :

+

coordinates :

+

country_code :

+

tz_hint :

+

Returns :

+
+
+
+
+

weather_location_clone ()

+
WeatherLocation *   weather_location_clone              (const WeatherLocation *location);
+

+

+
++ + + + + + + + + + +

location :

+

Returns :

+
+
+
+
+

weather_location_free ()

+
void                weather_location_free               (WeatherLocation *location);
+

+

+
++ + + + +

location :

+
+
+
+
+

weather_location_equal ()

+
gboolean            weather_location_equal              (const WeatherLocation *location1,
+                                                         const WeatherLocation *location2);
+

+

+
++ + + + + + + + + + + + + + +

location1 :

+

location2 :

+

Returns :

+
+
+
+
+

enum WeatherForecastType

+
typedef enum _WeatherForecastType {
+    FORECAST_STATE,
+    FORECAST_ZONE,
+    FORECAST_LIST
+} WeatherForecastType;
+
+

+

+
+
+
+

enum TempUnit

+
typedef enum {
+    TEMP_UNIT_INVALID = 0,
+    TEMP_UNIT_DEFAULT,
+    TEMP_UNIT_KELVIN,
+    TEMP_UNIT_CENTIGRADE,
+    TEMP_UNIT_FAHRENHEIT
+} TempUnit;
+
+

+

+
+
+
+

enum SpeedUnit

+
typedef enum {
+    SPEED_UNIT_INVALID = 0,
+    SPEED_UNIT_DEFAULT,
+    SPEED_UNIT_MS,    /* metres per second */
+    SPEED_UNIT_KPH,   /* kilometres per hour */
+    SPEED_UNIT_MPH,   /* miles per hour */
+    SPEED_UNIT_KNOTS, /* Knots */
+    SPEED_UNIT_BFT    /* Beaufort scale */
+} SpeedUnit;
+
+

+

+
+
+
+

enum PressureUnit

+
typedef enum {
+    PRESSURE_UNIT_INVALID = 0,
+    PRESSURE_UNIT_DEFAULT,
+    PRESSURE_UNIT_KPA,    /* kiloPascal */
+    PRESSURE_UNIT_HPA,    /* hectoPascal */
+    PRESSURE_UNIT_MB,     /* 1 millibars = 1 hectoPascal */
+    PRESSURE_UNIT_MM_HG,  /* millimeters of mecury */
+    PRESSURE_UNIT_INCH_HG, /* inches of mercury */
+    PRESSURE_UNIT_ATM     /* atmosphere */
+} PressureUnit;
+
+

+

+
+
+
+

enum DistanceUnit

+
typedef enum {
+    DISTANCE_UNIT_INVALID = 0,
+    DISTANCE_UNIT_DEFAULT,
+    DISTANCE_UNIT_METERS,
+    DISTANCE_UNIT_KM,
+    DISTANCE_UNIT_MILES
+} DistanceUnit;
+
+

+

+
+
+
+

WeatherPrefs

+
typedef struct {
+    WeatherForecastType type;
+
+    gboolean radar;
+    const char *radar_custom_url;
+
+    TempUnit temperature_unit;
+    SpeedUnit speed_unit;
+    PressureUnit pressure_unit;
+    DistanceUnit distance_unit;
+} WeatherPrefs;
+
+

+

+
+
+
+

WeatherInfo

+
typedef struct _WeatherInfo WeatherInfo;
+

+

+
+
+
+

WeatherInfoFunc ()

+
void                (*WeatherInfoFunc)                  (WeatherInfo *info,
+                                                         gpointer data);
+

+

+
++ + + + + + + + + + +

info :

+

data :

+
+
+
+
+

weather_info_new()

+
#define weather_info_new(location, prefs, cb, data) _weather_info_fill (NULL, (location), (prefs), (cb), (data))
+
+

+

+
++ + + + + + + + + + + + + + + + + + +

location :

+

prefs :

+

cb :

+

data :

+
+
+
+
+

weather_info_update()

+
#define weather_info_update(info, prefs, cb, data) _weather_info_fill ((info), NULL, (prefs), (cb), (data))
+
+

+

+
++ + + + + + + + + + + + + + + + + + +

info :

+

prefs :

+

cb :

+

data :

+
+
+
+
+

weather_info_abort ()

+
void                weather_info_abort                  (WeatherInfo *info);
+

+

+
++ + + + +

info :

+
+
+
+
+

weather_info_clone ()

+
WeatherInfo *       weather_info_clone                  (const WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_free ()

+
void                weather_info_free                   (WeatherInfo *info);
+

+

+
++ + + + +

info :

+
+
+
+
+

weather_info_is_valid ()

+
gboolean            weather_info_is_valid               (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_network_error ()

+
gboolean            weather_info_network_error          (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_to_metric ()

+
void                weather_info_to_metric              (WeatherInfo *info);
+

+

+
++ + + + +

info :

+
+
+
+
+

weather_info_to_imperial ()

+
void                weather_info_to_imperial            (WeatherInfo *info);
+

+

+
++ + + + +

info :

+
+
+
+
+

weather_info_get_location ()

+
const WeatherLocation * weather_info_get_location       (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_location_name ()

+
const gchar *       weather_info_get_location_name      (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_update ()

+
const gchar *       weather_info_get_update             (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_sky ()

+
const gchar *       weather_info_get_sky                (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_conditions ()

+
const gchar *       weather_info_get_conditions         (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_temp ()

+
const gchar *       weather_info_get_temp               (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_temp_min ()

+
const gchar *       weather_info_get_temp_min           (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_temp_max ()

+
const gchar *       weather_info_get_temp_max           (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_dew ()

+
const gchar *       weather_info_get_dew                (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_humidity ()

+
const gchar *       weather_info_get_humidity           (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_wind ()

+
const gchar *       weather_info_get_wind               (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_pressure ()

+
const gchar *       weather_info_get_pressure           (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_visibility ()

+
const gchar *       weather_info_get_visibility         (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_apparent ()

+
const gchar *       weather_info_get_apparent           (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_sunrise ()

+
const gchar *       weather_info_get_sunrise            (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_sunset ()

+
const gchar *       weather_info_get_sunset             (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_forecast ()

+
const gchar *       weather_info_get_forecast           (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_forecast_list ()

+
GSList *            weather_info_get_forecast_list      (WeatherInfo *info);
+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_radar ()

+
GdkPixbufAnimation * weather_info_get_radar             (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_temp_summary ()

+
const gchar *       weather_info_get_temp_summary       (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_weather_summary ()

+
gchar *             weather_info_get_weather_summary    (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_get_icon_name ()

+
const gchar *       weather_info_get_icon_name          (WeatherInfo *info);
+

+

+
++ + + + + + + + + + +

info :

+

Returns :

+
+
+
+
+

weather_info_next_sun_event ()

+
gint                weather_info_next_sun_event         (WeatherInfo *info);
+
++ + + + + + + + + + +

info :

+WeatherInfo structure +

Returns :

the interval, in seconds, until the next "sun event": + - local midnight, when rise and set times are recomputed + - next sunrise, when icon changes to daytime version + - next sunset, when icon changes to nighttime version +
+
+
+
+

enum WeatherWindDirection

+
enum WeatherWindDirection {
+    WIND_INVALID = -1,
+    WIND_VARIABLE,
+    WIND_N, WIND_NNE, WIND_NE, WIND_ENE,
+    WIND_E, WIND_ESE, WIND_SE, WIND_SSE,
+    WIND_S, WIND_SSW, WIND_SW, WIND_WSW,
+    WIND_W, WIND_WNW, WIND_NW, WIND_NNW,
+    WIND_LAST
+};
+
+

+

+
+
+
+

enum WeatherSky

+
enum WeatherSky {
+    SKY_INVALID = -1,
+    SKY_CLEAR,
+    SKY_BROKEN,
+    SKY_SCATTERED,
+    SKY_FEW,
+    SKY_OVERCAST,
+    SKY_LAST
+};
+
+

+

+
+
+
+

enum WeatherConditionPhenomenon

+
enum WeatherConditionPhenomenon {
+    PHENOMENON_INVALID = -1,
+
+    PHENOMENON_NONE,
+
+    PHENOMENON_DRIZZLE,
+    PHENOMENON_RAIN,
+    PHENOMENON_SNOW,
+    PHENOMENON_SNOW_GRAINS,
+    PHENOMENON_ICE_CRYSTALS,
+    PHENOMENON_ICE_PELLETS,
+    PHENOMENON_HAIL,
+    PHENOMENON_SMALL_HAIL,
+    PHENOMENON_UNKNOWN_PRECIPITATION,
+
+    PHENOMENON_MIST,
+    PHENOMENON_FOG,
+    PHENOMENON_SMOKE,
+    PHENOMENON_VOLCANIC_ASH,
+    PHENOMENON_SAND,
+    PHENOMENON_HAZE,
+    PHENOMENON_SPRAY,
+    PHENOMENON_DUST,
+
+    PHENOMENON_SQUALL,
+    PHENOMENON_SANDSTORM,
+    PHENOMENON_DUSTSTORM,
+    PHENOMENON_FUNNEL_CLOUD,
+    PHENOMENON_TORNADO,
+    PHENOMENON_DUST_WHIRLS,
+
+    PHENOMENON_LAST
+};
+
+

+

+
+
+
+

enum WeatherConditionQualifier

+
enum WeatherConditionQualifier {
+    QUALIFIER_INVALID = -1,
+
+    QUALIFIER_NONE,
+
+    QUALIFIER_VICINITY,
+
+    QUALIFIER_LIGHT,
+    QUALIFIER_MODERATE,
+    QUALIFIER_HEAVY,
+    QUALIFIER_SHALLOW,
+    QUALIFIER_PATCHES,
+    QUALIFIER_PARTIAL,
+    QUALIFIER_THUNDERSTORM,
+    QUALIFIER_BLOWING,
+    QUALIFIER_SHOWERS,
+    QUALIFIER_DRIFTING,
+    QUALIFIER_FREEZING,
+
+    QUALIFIER_LAST
+};
+
+

+

+
+
+
+

weather_info_get_value_update ()

+
gboolean            weather_info_get_value_update       (WeatherInfo *info,
+                                                         time_t *value);
+

+

+
++ + + + + + + + + + + + + + +

info :

+

value :

+

Returns :

+
+
+
+
+

weather_info_get_value_sky ()

+
gboolean            weather_info_get_value_sky          (WeatherInfo *info,
+                                                         WeatherSky *sky);
+

+

+
++ + + + + + + + + + + + + + +

info :

+

sky :

+

Returns :

+
+
+
+
+

weather_info_get_value_conditions ()

+
gboolean            weather_info_get_value_conditions   (WeatherInfo *info,
+                                                         WeatherConditionPhenomenon *phenomenon,
+                                                         WeatherConditionQualifier *qualifier);
+

+

+
++ + + + + + + + + + + + + + + + + + +

info :

+

phenomenon :

+

qualifier :

+

Returns :

+
+
+
+
+

weather_info_get_value_temp ()

+
gboolean            weather_info_get_value_temp         (WeatherInfo *info,
+                                                         TempUnit unit,
+                                                         gdouble *value);
+

+

+
++ + + + + + + + + + + + + + + + + + +

info :

+

unit :

+

value :

+

Returns :

+
+
+
+
+

weather_info_get_value_temp_min ()

+
gboolean            weather_info_get_value_temp_min     (WeatherInfo *info,
+                                                         TempUnit unit,
+                                                         gdouble *value);
+

+

+
++ + + + + + + + + + + + + + + + + + +

info :

+

unit :

+

value :

+

Returns :

+
+
+
+
+

weather_info_get_value_temp_max ()

+
gboolean            weather_info_get_value_temp_max     (WeatherInfo *info,
+                                                         TempUnit unit,
+                                                         gdouble *value);
+

+

+
++ + + + + + + + + + + + + + + + + + +

info :

+

unit :

+

value :

+

Returns :

+
+
+
+
+

weather_info_get_value_dew ()

+
gboolean            weather_info_get_value_dew          (WeatherInfo *info,
+                                                         TempUnit unit,
+                                                         gdouble *value);
+

+

+
++ + + + + + + + + + + + + + + + + + +

info :

+

unit :

+

value :

+

Returns :

+
+
+
+
+

weather_info_get_value_apparent ()

+
gboolean            weather_info_get_value_apparent     (WeatherInfo *info,
+                                                         TempUnit unit,
+                                                         gdouble *value);
+

+

+
++ + + + + + + + + + + + + + + + + + +

info :

+

unit :

+

value :

+

Returns :

+
+
+
+
+

weather_info_get_value_wind ()

+
gboolean            weather_info_get_value_wind         (WeatherInfo *info,
+                                                         SpeedUnit unit,
+                                                         gdouble *speed,
+                                                         WeatherWindDirection *direction);
+

+

+
++ + + + + + + + + + + + + + + + + + + + + + +

info :

+

unit :

+

speed :

+

direction :

+

Returns :

+
+
+
+
+

weather_info_get_value_pressure ()

+
gboolean            weather_info_get_value_pressure     (WeatherInfo *info,
+                                                         PressureUnit unit,
+                                                         gdouble *value);
+

+

+
++ + + + + + + + + + + + + + + + + + +

info :

+

unit :

+

value :

+

Returns :

+
+
+
+
+

weather_info_get_value_visibility ()

+
gboolean            weather_info_get_value_visibility   (WeatherInfo *info,
+                                                         DistanceUnit unit,
+                                                         gdouble *value);
+

+

+
++ + + + + + + + + + + + + + + + + + +

info :

+

unit :

+

value :

+

Returns :

+
+
+
+
+

weather_info_get_value_sunrise ()

+
gboolean            weather_info_get_value_sunrise      (WeatherInfo *info,
+                                                         time_t *value);
+

+

+
++ + + + + + + + + + + + + + +

info :

+

value :

+

Returns :

+
+
+
+
+

weather_info_get_value_sunset ()

+
gboolean            weather_info_get_value_sunset       (WeatherInfo *info,
+                                                         time_t *value);
+

+

+
++ + + + + + + + + + + + + + +

info :

+

value :

+

Returns :

+
+
+
+
+ + + \ No newline at end of file diff --git a/doc/html/libmateweather.devhelp b/doc/html/libmateweather.devhelp new file mode 100644 index 0000000..ab9e7b7 --- /dev/null +++ b/doc/html/libmateweather.devhelp @@ -0,0 +1,151 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/html/libmateweather.devhelp2 b/doc/html/libmateweather.devhelp2 new file mode 100644 index 0000000..6c0b186 --- /dev/null +++ b/doc/html/libmateweather.devhelp2 @@ -0,0 +1,158 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/html/right.png b/doc/html/right.png new file mode 100644 index 0000000..92832e3 Binary files /dev/null and b/doc/html/right.png differ diff --git a/doc/html/style.css b/doc/html/style.css new file mode 100644 index 0000000..82115eb --- /dev/null +++ b/doc/html/style.css @@ -0,0 +1,257 @@ +.synopsis, .classsynopsis +{ + /* tango:aluminium 1/2 */ + background: #eeeeec; + border: solid 1px #d3d7cf; + padding: 0.5em; +} +.programlisting +{ + /* tango:sky blue 0/1 */ + background: #e6f3ff; + border: solid 1px #729fcf; + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} + +@media screen { + sup a.footnote + { + position: relative; + top: 0em ! important; + + } + /* this is needed so that the local anchors are displayed below the naviagtion */ + div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] + { + position: relative; + padding-top:4.5em; + } + /* this seems to be a bug in the xsl style sheets when generating indexes */ + div.index div.index + { + top: 0em; + } + /* make space for the fixed navigation bar and add space at the bottom so that + * link targets appear somewhat close to top + */ + body + { + padding-top: 3.2em; + padding-bottom: 20em; + } + /* style and size the navigation bar */ + table.navigation#top + { + position: fixed; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + z-index: 10; + } + .navigation a, .navigation a:visited + { + /* tango:scarlet red 3 */ + color: #a40000; + } + .navigation a:hover + { + /* tango:scarlet red 1 */ + color: #ef2929; + } + td.shortcuts + { + /* tango:scarlet red 1 */ + color: #ef2929; + font-size: 80%; + white-space: nowrap; + } +} +@media print { + table.navigation { + visibility: collapse; + display: none; + } + div.titlepage table.navigation { + visibility: visible; + display: table; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + } +} + +.navigation .title +{ + font-size: 200%; +} + +div.gallery-float +{ + float: left; + padding: 10px; +} +div.gallery-float img +{ + border-style: none; +} +div.gallery-spacer +{ + clear: both; +} + +a, a:visited +{ + text-decoration: none; + /* tango:sky blue 2 */ + color: #3465a4; +} +a:hover +{ + text-decoration: underline; + /* tango:sky blue 1 */ + color: #729fcf; +} + +div.table table +{ + border-collapse: collapse; + border-spacing: 0px; + /* tango:aluminium 3 */ + border: solid 1px #babdb6; +} + +div.table table td, div.table table th +{ + /* tango:aluminium 3 */ + border: solid 1px #babdb6; + padding: 3px; + vertical-align: top; +} + +div.table table th +{ + /* tango:aluminium 2 */ + background-color: #d3d7cf; +} + +hr +{ + /* tango:aluminium 3 */ + color: #babdb6; + background: #babdb6; + border: none 0px; + height: 1px; + clear: both; +} + +.footer +{ + padding-top: 3.5em; + /* tango:aluminium 3 */ + color: #babdb6; + text-align: center; + font-size: 80%; +} + +.warning +{ + /* tango:orange 0/1 */ + background: #ffeed9; + border-color: #ffb04f; +} +.note +{ + /* tango:chameleon 0/0.5 */ + background: #d8ffb2; + border-color: #abf562; +} +.note, .warning +{ + padding: 0.5em; + border-width: 1px; + border-style: solid; +} +.note h3, .warning h3 +{ + margin-top: 0.0em +} +.note p, .warning p +{ + margin-bottom: 0.0em +} + +/* blob links */ +h2 .extralinks, h3 .extralinks +{ + float: right; + /* tango:aluminium 3 */ + color: #babdb6; + font-size: 80%; + font-weight: normal; +} + +/* code listings */ + +.listing_code .programlisting .cbracket { color: #a40000; } /* tango: scarlet red 3 */ +.listing_code .programlisting .comment { color: #a1a39d; } /* tango: aluminium 4 */ +.listing_code .programlisting .function { color: #000000; font-weight: bold; } +.listing_code .programlisting .function a { color: #11326b; font-weight: bold; } /* tango: sky blue 4 */ +.listing_code .programlisting .keyword { color: #4e9a06; } /* tango: chameleon 3 */ +.listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */ +.listing_code .programlisting .normal { color: #000000; } +.listing_code .programlisting .number { color: #75507b; } /* tango: plum 2 */ +.listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */ +.listing_code .programlisting .string { color: #c17d11; } /* tango: chocolate 2 */ +.listing_code .programlisting .type { color: #000000; } +.listing_code .programlisting .type a { color: #11326b; } /* tango: sky blue 4 */ +.listing_code .programlisting .symbol { color: #ce5c00; } /* tango: orange 3 */ + +.listing_frame { + /* tango:sky blue 1 */ + border: solid 1px #729fcf; + padding: 0px; +} + +.listing_lines, .listing_code { + margin-top: 0px; + margin-bottom: 0px; + padding: 0.5em; +} +.listing_lines { + /* tango:sky blue 0.5 */ + background: #a6c5e3; + /* tango:aluminium 6 */ + color: #2e3436; +} +.listing_code { + /* tango:sky blue 0 */ + background: #e6f3ff; +} +.listing_code .programlisting { + /* override from previous */ + border: none 0px; + padding: 0px; +} +.listing_lines pre, .listing_code pre { + margin: 0px; +} + diff --git a/doc/html/up.png b/doc/html/up.png new file mode 100644 index 0000000..85b3e2a Binary files /dev/null and b/doc/html/up.png differ diff --git a/doc/libmateweather-docs.sgml b/doc/libmateweather-docs.sgml new file mode 100644 index 0000000..09f13a5 --- /dev/null +++ b/doc/libmateweather-docs.sgml @@ -0,0 +1,25 @@ + + + + + libmateweather Reference Manual + + for libmateweather [VERSION] + The latest version of this documentation can be found on-line at + http://[SERVER]/libmateweather/. + + + + + [Insert title here] + + + + + + + + + + diff --git a/doc/libmateweather-overrides.txt b/doc/libmateweather-overrides.txt new file mode 100644 index 0000000..e69de29 diff --git a/doc/libmateweather-sections.txt b/doc/libmateweather-sections.txt new file mode 100644 index 0000000..7e9ef1d --- /dev/null +++ b/doc/libmateweather-sections.txt @@ -0,0 +1,185 @@ +
+timezone-menu +MateWeatherTimezoneMenu +MateWeatherTimezoneMenu +mateweather_timezone_menu_new +mateweather_timezone_menu_set_tzid +mateweather_timezone_menu_get_tzid + +MATEWEATHER_TIMEZONE_MENU +MATEWEATHER_IS_TIMEZONE_MENU +MATEWEATHER_TYPE_TIMEZONE_MENU +mateweather_timezone_menu_get_type +MATEWEATHER_TIMEZONE_MENU_CLASS +MATEWEATHER_IS_TIMEZONE_MENU_CLASS +MATEWEATHER_TIMEZONE_MENU_GET_CLASS +
+ +
+location-entry +MateWeatherLocationEntry +MateWeatherLocationEntry +mateweather_location_entry_new +mateweather_location_entry_set_location +mateweather_location_entry_get_location +mateweather_location_entry_set_city + +MATEWEATHER_LOCATION_ENTRY +MATEWEATHER_IS_LOCATION_ENTRY +MATEWEATHER_TYPE_LOCATION_ENTRY +mateweather_location_entry_get_type +MATEWEATHER_LOCATION_ENTRY_CLASS +MATEWEATHER_IS_LOCATION_ENTRY_CLASS +MATEWEATHER_LOCATION_ENTRY_GET_CLASS +
+ +
+mateweather-timezone +MateWeatherTimezone +mateweather_timezone_get_name +mateweather_timezone_get_tzid +mateweather_timezone_get_offset +mateweather_timezone_has_dst +mateweather_timezone_get_dst_offset +mateweather_timezone_ref +mateweather_timezone_unref + +mateweather_timezone_get_type +MATEWEATHER_TYPE_TIMEZONE +
+ +
+mateweather-xml +mateweather_xml_load_locations +
+ +
+mateweather-mateconf +MateWeatherMateConf +mateweather_mateconf_new +mateweather_mateconf_free +mateweather_mateconf_get_client +mateweather_mateconf_get_location +mateweather_mateconf_get_full_key +mateweather_mateconf_set_bool +mateweather_mateconf_set_int +mateweather_mateconf_set_string +mateweather_mateconf_get_bool +mateweather_mateconf_get_int +mateweather_mateconf_get_string +
+ +
+mateweather-prefs +MATECONF_TEMP_UNIT +MATECONF_SPEED_UNIT +MATECONF_PRESSURE_UNIT +MATECONF_DISTANCE_UNIT +MateWeatherPrefs +mateweather_prefs_load +mateweather_prefs_temp_enum_to_string +mateweather_prefs_speed_enum_to_string +mateweather_prefs_pressure_enum_to_string +mateweather_prefs_distance_enum_to_string +mateweather_prefs_parse_temperature +mateweather_prefs_parse_speed +mateweather_prefs_get_temp_display_name +mateweather_prefs_get_speed_display_name +mateweather_prefs_get_pressure_display_name +mateweather_prefs_get_distance_display_name +
+ +
+mateweather-location +MateWeatherLocation +MateWeatherLocationLevel +mateweather_location_new_world +mateweather_location_ref +mateweather_location_unref +mateweather_location_get_name +mateweather_location_get_sort_name +mateweather_location_get_level +mateweather_location_get_parent +mateweather_location_get_children +mateweather_location_free_children +mateweather_location_has_coords +mateweather_location_get_coords +mateweather_location_get_distance +mateweather_location_get_country +mateweather_location_get_timezone +mateweather_location_get_timezones +mateweather_location_free_timezones +mateweather_location_get_code +mateweather_location_get_city_name +mateweather_location_get_weather + +mateweather_location_get_type +MATEWEATHER_TYPE_LOCATION +
+ +
+weather +WeatherLocation +weather_location_new +weather_location_clone +weather_location_free +weather_location_equal +WeatherForecastType +TempUnit +SpeedUnit +PressureUnit +DistanceUnit +WeatherPrefs +WeatherInfo +WeatherInfoFunc +weather_info_new +weather_info_update +weather_info_abort +weather_info_clone +weather_info_free +weather_info_is_valid +weather_info_network_error +weather_info_to_metric +weather_info_to_imperial +weather_info_get_location +weather_info_get_location_name +weather_info_get_update +weather_info_get_sky +weather_info_get_conditions +weather_info_get_temp +weather_info_get_temp_min +weather_info_get_temp_max +weather_info_get_dew +weather_info_get_humidity +weather_info_get_wind +weather_info_get_pressure +weather_info_get_visibility +weather_info_get_apparent +weather_info_get_sunrise +weather_info_get_sunset +weather_info_get_forecast +weather_info_get_forecast_list +weather_info_get_radar +weather_info_get_temp_summary +weather_info_get_weather_summary +weather_info_get_icon_name +weather_info_next_sun_event +WeatherWindDirection +WeatherSky +WeatherConditionPhenomenon +WeatherConditionQualifier +weather_info_get_value_update +weather_info_get_value_sky +weather_info_get_value_conditions +weather_info_get_value_temp +weather_info_get_value_temp_min +weather_info_get_value_temp_max +weather_info_get_value_dew +weather_info_get_value_apparent +weather_info_get_value_wind +weather_info_get_value_pressure +weather_info_get_value_visibility +weather_info_get_value_sunrise +weather_info_get_value_sunset +
+ diff --git a/doc/libmateweather.types b/doc/libmateweather.types new file mode 100644 index 0000000..f09847a --- /dev/null +++ b/doc/libmateweather.types @@ -0,0 +1,5 @@ +mateweather_location_level_get_type +mateweather_timezone_get_type +mateweather_timezone_menu_get_type +mateweather_location_entry_get_type +mateweather_location_get_type diff --git a/doc/tmpl/libmateweather-unused.sgml b/doc/tmpl/libmateweather-unused.sgml new file mode 100644 index 0000000..5470c86 --- /dev/null +++ b/doc/tmpl/libmateweather-unused.sgml @@ -0,0 +1,493 @@ + + + + + + + + + + + + + + + + + + + + + +mateweather-enum-types + + + + + + + + + + + + + + + + + + + + + + + +parser + + + + + + + + + + + + + + + + + + + + + + + +weather-priv + + + + + + + + + + + + + + + + + + + + + + + + + +@deg: + + + + + + + + + + + + + + + + + + + + + + + + +@xml: +@locales: +@use_regions: +@year_start: +@year_end: + + + + + + +@str: + + + + + + +@inch: + + + + + + +@inch: + + + + + + +@inch: + + + + + + +@inch: + + + + + + +@inch: + + + + + + +@mbar: + + + + + + +@rad: + + + + + + +@rad: + + + + + + +@c: + + + + + + +@f: + + + + + + +@f: + + + + + + +@sm: + + + + + + +@sm: + + + + + + + + + + + + +@knots: + + + + + + +@knots: + + + + + + +@knots: + + + + + + +@knots: + + + + + + +@ms: + + + + + + +@significant: +@phenomenon: +@qualifier: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@str: + + + + + + +@info: + + + + + + +@info: +@Returns: + + + + + + +@info: + + + + + + +@str: +@Returns: + + + + + + +@Returns: + + + + + + +@Returns: + + + + + + +@gloc: +@name: +@Returns: + + + + + + +@parser: + + + + + + +@parser: +@Returns: + + + + + + +@parser: +@Returns: + + + + + + +@use_regions: +@Returns: + + + + + + +@Returns: + + + + + + +@parser: +@Returns: + + + + + + +@info: + + + + + + +@metar: +@info: +@Returns: + + + + + + +@info: + + + + + + +@info: + + + + + + +@info: +@ok: + + + + + + +@info: +@Returns: + + + + + + +@cond: +@Returns: + + + + + + +@sky: +@Returns: + + + + + + +@wind: +@Returns: + + + + + + +@info: + diff --git a/doc/tmpl/location-entry.sgml b/doc/tmpl/location-entry.sgml new file mode 100644 index 0000000..8c84c10 --- /dev/null +++ b/doc/tmpl/location-entry.sgml @@ -0,0 +1,73 @@ + +MateWeatherLocationEntry + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@top: +@Returns: + + + + + + + +@entry: +@loc: + + + + + + + +@entry: +@Returns: + + + + + + + +@entry: +@city_name: +@code: +@Returns: + + diff --git a/doc/tmpl/mateweather-enum-types.sgml b/doc/tmpl/mateweather-enum-types.sgml new file mode 100644 index 0000000..f94cf37 --- /dev/null +++ b/doc/tmpl/mateweather-enum-types.sgml @@ -0,0 +1,34 @@ + +mateweather-enum-types + + + + + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + + + + diff --git a/doc/tmpl/mateweather-location.sgml b/doc/tmpl/mateweather-location.sgml new file mode 100644 index 0000000..e64ff4c --- /dev/null +++ b/doc/tmpl/mateweather-location.sgml @@ -0,0 +1,210 @@ + +mateweather-location + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@MATEWEATHER_LOCATION_WORLD: +@MATEWEATHER_LOCATION_REGION: +@MATEWEATHER_LOCATION_COUNTRY: +@MATEWEATHER_LOCATION_ADM1: +@MATEWEATHER_LOCATION_ADM2: +@MATEWEATHER_LOCATION_CITY: +@MATEWEATHER_LOCATION_WEATHER_STATION: + + + + + + +@use_regions: +@Returns: + + + + + + + +@loc: +@Returns: + + + + + + + +@loc: + + + + + + + +@loc: +@Returns: + + + + + + + +@loc: +@Returns: + + + + + + + +@loc: +@Returns: + + + + + + + +@loc: +@Returns: + + + + + + + +@loc: +@Returns: + + + + + + + +@loc: +@children: + + + + + + + +@loc: +@Returns: + + + + + + + +@loc: +@latitude: +@longitude: + + + + + + + +@loc: +@loc2: +@Returns: + + + + + + + +@loc: +@Returns: + + + + + + + +@loc: +@Returns: + + + + + + + +@loc: +@Returns: + + + + + + + +@loc: +@zones: + + + + + + + +@loc: +@Returns: + + + + + + + +@loc: +@Returns: + + + + + + + +@loc: +@Returns: + + diff --git a/doc/tmpl/mateweather-mateconf.sgml b/doc/tmpl/mateweather-mateconf.sgml new file mode 100644 index 0000000..238ab34 --- /dev/null +++ b/doc/tmpl/mateweather-mateconf.sgml @@ -0,0 +1,136 @@ + +mateweather-mateconf + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@prefix: +@Returns: + + + + + + + +@ctx: + + + + + + + +@ctx: +@Returns: + + + + + + + +@ctx: +@Returns: + + + + + + + +@ctx: +@key: +@Returns: + + + + + + + +@ctx: +@key: +@the_bool: +@opt_error: + + + + + + + +@ctx: +@key: +@the_int: +@opt_error: + + + + + + + +@ctx: +@key: +@the_string: +@opt_error: + + + + + + + +@ctx: +@key: +@opt_error: +@Returns: + + + + + + + +@ctx: +@key: +@opt_error: +@Returns: + + + + + + + +@ctx: +@key: +@opt_error: +@Returns: + + diff --git a/doc/tmpl/mateweather-prefs.sgml b/doc/tmpl/mateweather-prefs.sgml new file mode 100644 index 0000000..20d078c --- /dev/null +++ b/doc/tmpl/mateweather-prefs.sgml @@ -0,0 +1,169 @@ + +mateweather-prefs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@location: +@update_interval: +@update_enabled: +@detailed: +@radar_enabled: +@use_custom_radar_url: +@radar: +@temperature_unit: +@use_temperature_default: +@speed_unit: +@use_speed_default: +@pressure_unit: +@use_pressure_default: +@distance_unit: +@use_distance_default: + + + + + + +@prefs: +@ctx: + + + + + + + +@temp: +@Returns: + + + + + + + +@speed: +@Returns: + + + + + + + +@pressure: +@Returns: + + + + + + + +@distance: +@Returns: + + + + + + + +@str: +@is_default: +@Returns: + + + + + + + +@str: +@is_default: +@Returns: + + + + + + + +@temp: +@Returns: + + + + + + + +@speed: +@Returns: + + + + + + + +@pressure: +@Returns: + + + + + + + +@distance: +@Returns: + + diff --git a/doc/tmpl/mateweather-timezone.sgml b/doc/tmpl/mateweather-timezone.sgml new file mode 100644 index 0000000..9438b25 --- /dev/null +++ b/doc/tmpl/mateweather-timezone.sgml @@ -0,0 +1,87 @@ + +mateweather-timezone + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@zone: +@Returns: + + + + + + + +@zone: +@Returns: + + + + + + + +@zone: +@Returns: + + + + + + + +@zone: +@Returns: + + + + + + + +@zone: +@Returns: + + + + + + + +@zone: +@Returns: + + + + + + + +@zone: + + diff --git a/doc/tmpl/mateweather-xml.sgml b/doc/tmpl/mateweather-xml.sgml new file mode 100644 index 0000000..2a33dcd --- /dev/null +++ b/doc/tmpl/mateweather-xml.sgml @@ -0,0 +1,27 @@ + +mateweather-xml + + + + + + + + + + + + + + + + + + + + + + +@Returns: + + diff --git a/doc/tmpl/parser.sgml b/doc/tmpl/parser.sgml new file mode 100644 index 0000000..de1e4ee --- /dev/null +++ b/doc/tmpl/parser.sgml @@ -0,0 +1,74 @@ + +parser + + + + + + + + + + + + + + + + + + + + + + +@xml: +@locales: +@use_regions: +@year_start: +@year_end: + + + + + + +@use_regions: +@Returns: + + + + + + + +@parser: + + + + + + + +@parser: +@Returns: + + + + + + + +@parser: +@Returns: + + + + + + + +@parser: +@Returns: + + diff --git a/doc/tmpl/timezone-menu.sgml b/doc/tmpl/timezone-menu.sgml new file mode 100644 index 0000000..7ab4304 --- /dev/null +++ b/doc/tmpl/timezone-menu.sgml @@ -0,0 +1,62 @@ + +MateWeatherTimezoneMenu + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@top: +@Returns: + + + + + + + +@menu: +@tzid: + + + + + + + +@menu: +@Returns: + + diff --git a/doc/tmpl/weather-priv.sgml b/doc/tmpl/weather-priv.sgml new file mode 100644 index 0000000..0393cc8 --- /dev/null +++ b/doc/tmpl/weather-priv.sgml @@ -0,0 +1,430 @@ + +weather-priv + + + + + + + + + + + + + + + + + + + + + + +@str: +@Returns: + + + + + + + +@str: + + + + + + + +@str: + + + + + + + + + + + + + + +@gloc: +@name: +@Returns: + + + + + + + +@significant: +@phenomenon: +@qualifier: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@forecast_type: +@temperature_unit: +@speed_unit: +@pressure_unit: +@distance_unit: +@valid: +@network_error: +@sunValid: +@tempMinMaxValid: +@location: +@update: +@sky: +@cond: +@temp: +@temp_min: +@temp_max: +@dew: +@wind: +@windspeed: +@pressure: +@visibility: +@sunrise: +@sunset: +@forecast: +@forecast_list: +@radar_buffer: +@radar_url: +@radar_loader: +@radar: +@session: +@requests_pending: +@finish_cb: +@cb_data: + + + + + + +@wind: +@Returns: + + + + + + + +@sky: +@Returns: + + + + + + + +@cond: +@Returns: + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@f: + + + + + + + +@f: + + + + + + + +@c: + + + + + + + +@knots: + + + + + + + +@knots: + + + + + + + +@knots: + + + + + + + +@ms: + + + + + + + +@knots: + + + + + + + +@inch: + + + + + + + +@inch: + + + + + + + +@inch: + + + + + + + +@inch: + + + + + + + +@inch: + + + + + + + +@mbar: + + + + + + + +@sm: + + + + + + + +@sm: + + + + + + + +@deg: + + + + + + + +@rad: + + + + + + + +@rad: + + + + + + + +@info: + + + + + + + +@info: + + + + + + + +@info: + + + + + + + +@info: + + + + + + + +@info: + + + + + + + +@metar: +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@ok: + + + + + + + +@info: +@Returns: + + + + + + + +@info: + + diff --git a/doc/tmpl/weather.sgml b/doc/tmpl/weather.sgml new file mode 100644 index 0000000..3df6757 --- /dev/null +++ b/doc/tmpl/weather.sgml @@ -0,0 +1,683 @@ + +weather + + + + + + + + + + + + + + + + + + + + + + +@name: +@code: +@zone: +@radar: +@zone_valid: +@coordinates: +@latitude: +@longitude: +@latlon_valid: +@country_code: +@tz_hint: + + + + + + +@trans_name: +@code: +@zone: +@radar: +@coordinates: +@country_code: +@tz_hint: +@Returns: + + + + + + + +@location: +@Returns: + + + + + + + +@location: + + + + + + + +@location1: +@location2: +@Returns: + + + + + + + +@FORECAST_STATE: +@FORECAST_ZONE: +@FORECAST_LIST: + + + + + + +@TEMP_UNIT_INVALID: +@TEMP_UNIT_DEFAULT: +@TEMP_UNIT_KELVIN: +@TEMP_UNIT_CENTIGRADE: +@TEMP_UNIT_FAHRENHEIT: + + + + + + +@SPEED_UNIT_INVALID: +@SPEED_UNIT_DEFAULT: +@SPEED_UNIT_MS: +@SPEED_UNIT_KPH: +@SPEED_UNIT_MPH: +@SPEED_UNIT_KNOTS: +@SPEED_UNIT_BFT: + + + + + + +@PRESSURE_UNIT_INVALID: +@PRESSURE_UNIT_DEFAULT: +@PRESSURE_UNIT_KPA: +@PRESSURE_UNIT_HPA: +@PRESSURE_UNIT_MB: +@PRESSURE_UNIT_MM_HG: +@PRESSURE_UNIT_INCH_HG: +@PRESSURE_UNIT_ATM: + + + + + + +@DISTANCE_UNIT_INVALID: +@DISTANCE_UNIT_DEFAULT: +@DISTANCE_UNIT_METERS: +@DISTANCE_UNIT_KM: +@DISTANCE_UNIT_MILES: + + + + + + +@type: +@radar: +@radar_custom_url: +@temperature_unit: +@speed_unit: +@pressure_unit: +@distance_unit: + + + + + + + + + + + + +@info: +@data: + + + + + + + +@location: +@prefs: +@cb: +@data: + + + + + + + +@info: +@prefs: +@cb: +@data: + + + + + + + +@info: + + + + + + + +@info: +@Returns: + + + + + + + +@info: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: + + + + + + + +@info: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@WIND_INVALID: +@WIND_VARIABLE: +@WIND_N: +@WIND_NNE: +@WIND_NE: +@WIND_ENE: +@WIND_E: +@WIND_ESE: +@WIND_SE: +@WIND_SSE: +@WIND_S: +@WIND_SSW: +@WIND_SW: +@WIND_WSW: +@WIND_W: +@WIND_WNW: +@WIND_NW: +@WIND_NNW: +@WIND_LAST: + + + + + + +@SKY_INVALID: +@SKY_CLEAR: +@SKY_BROKEN: +@SKY_SCATTERED: +@SKY_FEW: +@SKY_OVERCAST: +@SKY_LAST: + + + + + + +@PHENOMENON_INVALID: +@PHENOMENON_NONE: +@PHENOMENON_DRIZZLE: +@PHENOMENON_RAIN: +@PHENOMENON_SNOW: +@PHENOMENON_SNOW_GRAINS: +@PHENOMENON_ICE_CRYSTALS: +@PHENOMENON_ICE_PELLETS: +@PHENOMENON_HAIL: +@PHENOMENON_SMALL_HAIL: +@PHENOMENON_UNKNOWN_PRECIPITATION: +@PHENOMENON_MIST: +@PHENOMENON_FOG: +@PHENOMENON_SMOKE: +@PHENOMENON_VOLCANIC_ASH: +@PHENOMENON_SAND: +@PHENOMENON_HAZE: +@PHENOMENON_SPRAY: +@PHENOMENON_DUST: +@PHENOMENON_SQUALL: +@PHENOMENON_SANDSTORM: +@PHENOMENON_DUSTSTORM: +@PHENOMENON_FUNNEL_CLOUD: +@PHENOMENON_TORNADO: +@PHENOMENON_DUST_WHIRLS: +@PHENOMENON_LAST: + + + + + + +@QUALIFIER_INVALID: +@QUALIFIER_NONE: +@QUALIFIER_VICINITY: +@QUALIFIER_LIGHT: +@QUALIFIER_MODERATE: +@QUALIFIER_HEAVY: +@QUALIFIER_SHALLOW: +@QUALIFIER_PATCHES: +@QUALIFIER_PARTIAL: +@QUALIFIER_THUNDERSTORM: +@QUALIFIER_BLOWING: +@QUALIFIER_SHOWERS: +@QUALIFIER_DRIFTING: +@QUALIFIER_FREEZING: +@QUALIFIER_LAST: + + + + + + +@info: +@value: +@Returns: + + + + + + + +@info: +@sky: +@Returns: + + + + + + + +@info: +@phenomenon: +@qualifier: +@Returns: + + + + + + + +@info: +@unit: +@value: +@Returns: + + + + + + + +@info: +@unit: +@value: +@Returns: + + + + + + + +@info: +@unit: +@value: +@Returns: + + + + + + + +@info: +@unit: +@value: +@Returns: + + + + + + + +@info: +@unit: +@value: +@Returns: + + + + + + + +@info: +@unit: +@speed: +@direction: +@Returns: + + + + + + + +@info: +@unit: +@value: +@Returns: + + + + + + + +@info: +@unit: +@value: +@Returns: + + + + + + + +@info: +@value: +@Returns: + + + + + + + +@info: +@value: +@Returns: + + -- cgit v1.2.1