From: Kate Alhola Date: Thu, 11 Feb 2010 21:13:20 +0000 (+0200) Subject: Web page and doxygen documentation created X-Git-Url: http://git.maemo.org/git/?p=tpsession;a=commitdiff_plain;h=39c01267eba450aed214c0b91fda0d9c45245a57 Web page and doxygen documentation created --- diff --git a/tpsession-0.1/doc/MaemoTelepathy.odt b/tpsession-0.1/doc/MaemoTelepathy.odt index 6d4f378..1b42c61 100644 Binary files a/tpsession-0.1/doc/MaemoTelepathy.odt and b/tpsession-0.1/doc/MaemoTelepathy.odt differ diff --git a/tpsession-0.1/doc/Telepathy-diag.odg b/tpsession-0.1/doc/Telepathy-diag.odg new file mode 100644 index 0000000..76a7157 Binary files /dev/null and b/tpsession-0.1/doc/Telepathy-diag.odg differ diff --git a/tpsession-0.1/doc/Telepathy-diag.png b/tpsession-0.1/doc/Telepathy-diag.png new file mode 100644 index 0000000..5253bc1 Binary files /dev/null and b/tpsession-0.1/doc/Telepathy-diag.png differ diff --git a/tpsession-0.1/doc/doxygen-footer.html b/tpsession-0.1/doc/doxygen-footer.html new file mode 100644 index 0000000..39a1f80 --- /dev/null +++ b/tpsession-0.1/doc/doxygen-footer.html @@ -0,0 +1,7 @@ +

+ + + +
Copyright © 2010 Nokia Corporation
TpSession $projectnumber
+ + diff --git a/tpsession-0.1/doc/doxygen-header.html b/tpsession-0.1/doc/doxygen-header.html new file mode 100644 index 0000000..e3e5630 --- /dev/null +++ b/tpsession-0.1/doc/doxygen-header.html @@ -0,0 +1,30 @@ + + + + + $title + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + diff --git a/tpsession-0.1/doc/doxygen.cfg b/tpsession-0.1/doc/doxygen.cfg new file mode 100644 index 0000000..5b70b13 --- /dev/null +++ b/tpsession-0.1/doc/doxygen.cfg @@ -0,0 +1,1412 @@ +# Doxyfile 1.5.6 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = tpsession + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = $(VERSION) + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = . + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, +# and Ukrainian. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = YES + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = NO + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = $(SRCDIR) + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen to replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = NO + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = YES + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = NO + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = YES + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = NO + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = NO + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = NO + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = NO + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 0 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = NO + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = NO + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = NO + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = YES + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = doxygen.log + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = ../tpsession + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 + +FILE_PATTERNS = *.h *.cpp *.dox + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = YES + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. Otherwise they will link to the documentstion. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = NO + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = yes + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = doxygen-header.html + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = doxygen-footer.html + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = doxygen.css + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = NO + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = ../$(PROJECT).chm + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = $(HHC_PATH) + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = $(GENERATE_CHI) + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = YES + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to FRAME, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. Other possible values +# for this tag are: HIERARCHIES, which will generate the Groups, Directories, +# and Class Hiererachy pages using a tree view instead of an ordered list; +# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which +# disables this behavior completely. For backwards compatibility with previous +# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE +# respectively. + +GENERATE_TREEVIEW = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = $(GENERATE_LATEX) + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4 + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = NO + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = NO + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = YES + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = $(GENERATE_RTF) + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = $(GENERATE_MAN) + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .1 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = $(GENERATE_XML) + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = * + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse +# the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = $(PERL_PATH) + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more +# powerful graphs. + +CLASS_DIAGRAMS = NO + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = YES + +# By default doxygen will write a font called FreeSans.ttf to the output +# directory and reference it in all dot files that doxygen generates. This +# font does not include all possible unicode characters however, so when you need +# these (or just want a differently looking font) you can specify the font name +# using DOT_FONTNAME. You need need to make sure dot is able to find the font, +# which can be done by putting it in a standard location or by setting the +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory +# containing the font. + +DOT_FONTNAME = FreeSans + +# By default doxygen will tell dot to use the output directory to look for the +# FreeSans.ttf font (which doxygen will put there itself). If you specify a +# different font using DOT_FONTNAME you can set the path where dot +# can find it using this tag. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = NO + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = $(DOT_PATH) + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is enabled by default, which results in a transparent +# background. Warning: Depending on the platform used, enabling this option +# may lead to badly anti-aliased labels on the edges of a graph (i.e. they +# become hard to read). + +DOT_TRANSPARENT = YES + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO + + diff --git a/tpsession-0.1/doc/doxygen.css b/tpsession-0.1/doc/doxygen.css new file mode 100644 index 0000000..c826613 --- /dev/null +++ b/tpsession-0.1/doc/doxygen.css @@ -0,0 +1,429 @@ +body, table, div, p, dl { + font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; + font-size: 12px; +} + +/* @group Heading Levels */ + +h1 { + text-align: center; + font-size: 150%; +} + +h2 { + font-size: 120%; +} + +h3 { + font-size: 100%; +} + +/* @end */ + +caption { + font-weight: bold; +} + +div.qindex, div.navtab{ + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + padding: 2px; +} + +div.qindex, div.navpath { + width: 100%; + line-height: 140%; +} + +div.navtab { + margin-right: 15px; +} + +/* @group Link Styling */ + +a { + color: #153788; + font-weight: normal; + text-decoration: none; +} + +.contents a:visited { + color: #1b77c5; +} + +a:hover { + text-decoration: underline; +} + +a.qindex { + font-weight: bold; +} + +a.qindexHL { + font-weight: bold; + background-color: #6666cc; + color: #ffffff; + border: 1px double #9295C2; +} + +.contents a.qindexHL:visited { + color: #ffffff; +} + +a.el { + font-weight: bold; +} + +a.elRef { +} + +a.code { +} + +a.codeRef { +} + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +.fragment { + font-family: monospace, fixed; + font-size: 105%; +} + +pre.fragment { + border: 1px solid #CCCCCC; + background-color: #f5f5f5; + padding: 4px 6px; + margin: 4px 8px 4px 2px; +} + +div.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + margin-bottom: 6px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + background: white; + color: black; + margin-right: 20px; + margin-left: 20px; +} + +td.indexkey { + background-color: #e8eef2; + font-weight: bold; + border: 1px solid #CCCCCC; + margin: 2px 0px 2px 0; + padding: 2px 10px; +} + +td.indexvalue { + background-color: #e8eef2; + border: 1px solid #CCCCCC; + padding: 2px 10px; + margin: 2px 0px; +} + +tr.memlist { + background-color: #f0f0f0; +} + +p.formulaDsp { + text-align: center; +} + +img.formulaDsp { + +} + +img.formulaInl { + vertical-align: middle; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 +} + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +/* @end */ + +.search { + color: #003399; + font-weight: bold; +} + +form.search { + margin-bottom: 0px; + margin-top: 0px; +} + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #84b0c7; +} + +th.dirtab { + background: #e8eef2; + font-weight: bold; +} + +hr { + height: 0; + border: none; + border-top: 1px solid #666; +} + +/* @group Member Descriptions */ + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: #FAFAFA; + border: none; + margin: 4px; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: #555; +} + +.memItemLeft, .memItemRight, .memTemplParams { + border-top: 1px solid #ccc; +} + +.memTemplParams { + color: #606060; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtemplate { + font-size: 80%; + color: #606060; + font-weight: normal; + margin-left: 3px; +} + +.memnav { + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.memitem { + padding: 0; +} + +.memname { + white-space: nowrap; + font-weight: bold; +} + +.memproto { + padding: 0; + background-color: #d5e1e8; + font-weight: bold; + border: 1px solid #84b0c7; +} + +.memdoc { + padding: 2px 5px; + border-top-width: 0; +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #602020; + white-space: nowrap; +} +.paramname em { + font-style: normal; +} + +/* @end */ + +/* @group Directory (tree) */ + +/* for the tree view */ + +.ftvtree { + font-family: sans-serif; + margin: 0.5em; +} + +/* these are for tree view when used as main index */ + +.directory { + font-size: 9pt; + font-weight: bold; +} + +.directory h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +/* +The following two styles can be used to replace the root node title +with an image of your choice. Simply uncomment the next two styles, +specify the name of your image and be sure to set 'height' to the +proper pixel height of your image. +*/ + +/* +.directory h3.swap { + height: 61px; + background-repeat: no-repeat; + background-image: url("yourimage.gif"); +} +.directory h3.swap span { + display: none; +} +*/ + +.directory > h3 { + margin-top: 0; +} + +.directory p { + margin: 0px; + white-space: nowrap; +} + +.directory div { + display: none; + margin: 0px; +} + +.directory img { + vertical-align: -30%; +} + +/* these are for tree view when not used as main index */ + +.directory-alt { + font-size: 100%; + font-weight: bold; +} + +.directory-alt h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +.directory-alt > h3 { + margin-top: 0; +} + +.directory-alt p { + margin: 0px; + white-space: nowrap; +} + +.directory-alt div { + display: none; + margin: 0px; +} + +.directory-alt img { + vertical-align: -30%; +} + +/* @end */ + +address { + font-style: normal; + color: #333; +} diff --git a/tpsession-0.1/doc/doxygen.log b/tpsession-0.1/doc/doxygen.log new file mode 100644 index 0000000..a81e995 --- /dev/null +++ b/tpsession-0.1/doc/doxygen.log @@ -0,0 +1,60 @@ +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/moc_tpsession.cpp:64: Warning: documented function `const QMetaObject staticMetaObject' was not declared or defined. +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/moc_tpsession.cpp:71: Warning: documented function `const QMetaObject * metaObject' was not declared or defined. +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/moc_tpsession.cpp:76: Warning: documented function `void * qt_metacast' was not declared or defined. +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/moc_tpsession.cpp:84: Warning: documented function `int qt_metacall' was not declared or defined. +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/moc_tpsessionaccount.cpp:71: Warning: documented function `const QMetaObject staticMetaObject' was not declared or defined. +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/moc_tpsessionaccount.cpp:78: Warning: documented function `const QMetaObject * metaObject' was not declared or defined. +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/moc_tpsessionaccount.cpp:83: Warning: documented function `void * qt_metacast' was not declared or defined. +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/moc_tpsessionaccount.cpp:91: Warning: documented function `int qt_metacall' was not declared or defined. +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/moc_tpsessionchannel.cpp:66: Warning: documented function `const QMetaObject staticMetaObject' was not declared or defined. +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/moc_tpsessionchannel.cpp:73: Warning: documented function `const QMetaObject * metaObject' was not declared or defined. +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/moc_tpsessionchannel.cpp:78: Warning: documented function `void * qt_metacast' was not declared or defined. +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/moc_tpsessionchannel.cpp:86: Warning: documented function `int qt_metacall' was not declared or defined. +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/moc_tpsessionobserver.cpp:43: Warning: documented function `const QMetaObject staticMetaObject' was not declared or defined. +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/moc_tpsessionobserver.cpp:50: Warning: documented function `const QMetaObject * metaObject' was not declared or defined. +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/moc_tpsessionobserver.cpp:55: Warning: documented function `void * qt_metacast' was not declared or defined. +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/moc_tpsessionobserver.cpp:65: Warning: documented function `int qt_metacall' was not declared or defined. +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsessionchannel.cpp:50: Warning: no uniquely matching class member found for + void messageReceived(const Tp::ReceivedMessage &, TpSessionConnection *) +Possible candidates: + void TpSessionChannel::messageReceived(const Tp::ReceivedMessage &, TpSessionChannel *) at line 47 of file /home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsessionchannel.h +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsession.cpp:44: Warning: argument 'TpSession' of command @param is not found in the argument list of TpSession::amReady(TpSession *_t1) +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsession.cpp:44: Warning: The following parameters of TpSession::amReady(TpSession *_t1) are not documented: + parameter '_t1' +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsession.cpp:37: Warning: argument 'TpSessionAccount' of command @param is not found in the argument list of TpSession::accountReady(TpSessionAccount *_t1) +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsession.cpp:37: Warning: The following parameters of TpSession::accountReady(TpSessionAccount *_t1) are not documented: + parameter '_t1' +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsession.cpp:51: Warning: argument 'Tp' of command @param is not found in the argument list of TpSession::messageReceived(const Tp::ReceivedMessage &_t1, TpSessionAccount *_t2) +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsession.cpp:51: Warning: argument 'ReceivedMessage' of command @param is not found in the argument list of TpSession::messageReceived(const Tp::ReceivedMessage &_t1, TpSessionAccount *_t2) +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsession.cpp:51: Warning: argument 'TpSessionAccount' of command @param is not found in the argument list of TpSession::messageReceived(const Tp::ReceivedMessage &_t1, TpSessionAccount *_t2) +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsession.cpp:51: Warning: The following parameters of TpSession::messageReceived(const Tp::ReceivedMessage &_t1, TpSessionAccount *_t2) are not documented: + parameter '_t1' + parameter '_t2' +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsessionaccount.cpp:33: Warning: argument 'TpSessionAccount' of command @param is not found in the argument list of TpSessionAccount::accountReady(TpSessionAccount *_t1) +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsessionaccount.cpp:33: Warning: The following parameters of TpSessionAccount::accountReady(TpSessionAccount *_t1) are not documented: + parameter '_t1' +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsessionaccount.cpp:40: Warning: argument 'TpSession' of command @param is not found in the argument list of TpSessionAccount::channelReady(TpSessionAccount *_t1) +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsessionaccount.cpp:40: Warning: The following parameters of TpSessionAccount::channelReady(TpSessionAccount *_t1) are not documented: + parameter '_t1' +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsessionaccount.cpp:47: Warning: argument 'Tp' of command @param is not found in the argument list of TpSessionAccount::messageReceived(const Tp::ReceivedMessage &_t1, TpSessionAccount *_t2) +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsessionaccount.cpp:47: Warning: argument 'ReceivedMessage' of command @param is not found in the argument list of TpSessionAccount::messageReceived(const Tp::ReceivedMessage &_t1, TpSessionAccount *_t2) +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsessionaccount.cpp:47: Warning: argument 'TpSessionAccount' of command @param is not found in the argument list of TpSessionAccount::messageReceived(const Tp::ReceivedMessage &_t1, TpSessionAccount *_t2) +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsessionaccount.cpp:47: Warning: The following parameters of TpSessionAccount::messageReceived(const Tp::ReceivedMessage &_t1, TpSessionAccount *_t2) are not documented: + parameter '_t1' + parameter '_t2' +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsessionchannel.cpp:91: Warning: argument 'conn' of command @param is not found in the argument list of TpSessionChannel::TpSessionChannel(Tp::TextChannelPtr ch) +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsessionchannel.cpp:91: Warning: The following parameters of TpSessionChannel::TpSessionChannel(Tp::TextChannelPtr ch) are not documented: + parameter 'ch' +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsessionchannel.cpp:34: Warning: argument 'TpSessionChannel' of command @param is not found in the argument list of TpSessionChannel::channelReady(TpSessionChannel *_t1) +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsessionchannel.cpp:34: Warning: The following parameters of TpSessionChannel::channelReady(TpSessionChannel *_t1) are not documented: + parameter '_t1' +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsessionchannel.cpp:41: Warning: argument 'TpSessionChannel' of command @param is not found in the argument list of TpSessionChannel::channelDestroyed(TpSessionChannel *_t1) +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsessionchannel.cpp:41: Warning: The following parameters of TpSessionChannel::channelDestroyed(TpSessionChannel *_t1) are not documented: + parameter '_t1' +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsessionchannel.cpp:57: Warning: argument 'Tp' of command @param is not found in the argument list of TpSessionChannel::messageSent(const Tp::Message &_t1, Tp::MessageSendingFlags _t2, const QString &_t3, TpSessionChannel *_t4) +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsessionchannel.cpp:57: Warning: argument 'Message' of command @param is not found in the argument list of TpSessionChannel::messageSent(const Tp::Message &_t1, Tp::MessageSendingFlags _t2, const QString &_t3, TpSessionChannel *_t4) +/home/kathy/sb/fremantle/tpsession/tpsession-0.1/tpsession/tpsessionchannel.cpp:57: Warning: The following parameters of TpSessionChannel::messageSent(const Tp::Message &_t1, Tp::MessageSendingFlags _t2, const QString &_t3, TpSessionChannel *_t4) are not documented: + parameter '_t1' + parameter '_t2' + parameter '_t3' + parameter '_t4' diff --git a/tpsession-0.1/tpsession/libtpsession.so.0.1.0 b/tpsession-0.1/tpsession/libtpsession.so.0.1.0 index 59914b0..79429af 100755 Binary files a/tpsession-0.1/tpsession/libtpsession.so.0.1.0 and b/tpsession-0.1/tpsession/libtpsession.so.0.1.0 differ diff --git a/tpsession-0.1/tpsession/libtpsession.so.1 b/tpsession-0.1/tpsession/libtpsession.so.1 deleted file mode 120000 index 3f6c7ce..0000000 --- a/tpsession-0.1/tpsession/libtpsession.so.1 +++ /dev/null @@ -1 +0,0 @@ -libtpsession.so.1.0.0 \ No newline at end of file diff --git a/tpsession-0.1/tpsession/libtpsession.so.1.0 b/tpsession-0.1/tpsession/libtpsession.so.1.0 deleted file mode 120000 index 3f6c7ce..0000000 --- a/tpsession-0.1/tpsession/libtpsession.so.1.0 +++ /dev/null @@ -1 +0,0 @@ -libtpsession.so.1.0.0 \ No newline at end of file diff --git a/tpsession-0.1/tpsession/libtpsession.so.1.0.0 b/tpsession-0.1/tpsession/libtpsession.so.1.0.0 deleted file mode 100755 index 4da1d24..0000000 Binary files a/tpsession-0.1/tpsession/libtpsession.so.1.0.0 and /dev/null differ diff --git a/tpsession-0.1/tpsession/tpsession-0.1.tgz b/tpsession-0.1/tpsession/tpsession-0.1.tgz deleted file mode 100644 index 2ba7509..0000000 Binary files a/tpsession-0.1/tpsession/tpsession-0.1.tgz and /dev/null differ diff --git a/tpsession-0.1/tpsession/tpsession.cpp b/tpsession-0.1/tpsession/tpsession.cpp index 95161a0..903e92b 100644 --- a/tpsession-0.1/tpsession/tpsession.cpp +++ b/tpsession-0.1/tpsession/tpsession.cpp @@ -2,7 +2,7 @@ * This file is part of TpSession * * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). - * Contact Kate Alhola kate.alholanokia.com + * Contact Kate Alhola kate.alhola(a)nokia.com * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public @@ -21,6 +21,50 @@ #include "tpsession.h" #include + + + + +/** + * \class TpSession + * \headerfile + * + * Top level class, counterpart of Account Manager. TpSession connects to account manager and requests accounts from it. TpSession creates TpSessionAccount for all accounts . + * As top level class TpSession provides simålified interface to send and receive messages via any account. TpSession provides signal when it has accounts ready. + * If you require some specific account in constructor, you will receive signal only when this account is ready. If you use constructor without any parameters, you will get one + * signal for every account. If synchronous is true, constructor is executed as synchronous and it does return after transactions to set up accounts are done. + */ +/** + * \fn void TpSession::accountReady(TpSessionAccount *); + * + * Emitted when the account becomes ready + * + * \param TpSessionAccount pointer to account become ready + */ +/** + * \fn void TpSession::amReady(TpSession *); + * + * Emitted when the account Manager becomes ready + * + * \param TpSession pointer to TpSession class + */ +/** + * \fn void TpSession::messageReceived(const Tp::ReceivedMessage &,TpSessionAccount *); + * + * Emitted when any of Account Managers recived message + * + * \param Tp::ReceivedMessage Message received + * \param TpSessionAccount pointer to account received message + */ + + +/** + * Construct a new TpSession object. + * + * \param cmname Name of the default connection manager. Can be empty or omnitted, then there is no default connection manager + * \param synchronous if false, asynchronous behavior, function returns immediately and accountReady signals are emitted when accounts are ready + * if True, synchronous behavior and function returns when accounts are ready + */ TpSession::TpSession(QString cmname,bool synchronous) { Tp::registerTypes(); @@ -42,6 +86,12 @@ TpSession::TpSession(QString cmname,bool synchronous) } TpSession* TpSession::instancePtr=NULL; +/** + * Returns pointer to TpSession singleton. If there is not yet TpSession Object, creates it with "Ring" connection manager as default + * + * \param synchronous if false, asynchronous behavior, function returns immediately and accountReady signals are emitted when accounts are ready + * if True, synchronous behavior and function returns when accounts are ready + */ TpSession* TpSession::instance(bool synchronous) { if(instancePtr==NULL) instancePtr=new TpSession("ring",synchronous); @@ -92,12 +142,24 @@ void TpSession::onMessageReceived(const Tp::ReceivedMessage &msg,TpSessionAccoun emit messageReceived(msg,acc); } +/** + * Send message using specified connection manager to address + * + * \param connectionMgr Name of the connection manager + * \param address Valid address for this connection manager type. Asexample telephone number to Ring, GoogleTalk address for Gabble + * \param message Message body + */ void TpSession::sendMessageToAddress(QString connectionMgr,QString address,QString message) { TpSessionAccount *tpsa=getAccount(connectionMgr); if(tpsa) tpsa->sendMessageToAddress(address,message); } - +/** + * Returns pointer to TpSessionAccout object with specified connection manager or protocol, returns NULL if no match found + * + * \param cm Name of the connection manager, if left empty matches every entry + * \param protocol Name of the protocol manager, if left empty matches every entry + */ TpSessionAccount* TpSession::getAccount(const QString cm,QString protocol) { qDebug() << "TpSession::getAccount" << cm << " " << protocol; diff --git a/tpsession-0.1/tpsession/tpsession/tpsession.cpp b/tpsession-0.1/tpsession/tpsession/tpsession.cpp deleted file mode 100644 index c6e69cc..0000000 --- a/tpsession-0.1/tpsession/tpsession/tpsession.cpp +++ /dev/null @@ -1,6 +0,0 @@ -#include "tpsession.h" - - -Tpsession::Tpsession() -{ -} diff --git a/tpsession-0.1/tpsession/tpsession/tpsession.h b/tpsession-0.1/tpsession/tpsession/tpsession.h deleted file mode 100644 index 7cefc43..0000000 --- a/tpsession-0.1/tpsession/tpsession/tpsession.h +++ /dev/null @@ -1,10 +0,0 @@ -#ifndef TPSESSION_H -#define TPSESSION_H - - -class Tpsession { -public: - Tpsession(); -}; - -#endif // TPSESSION_H diff --git a/tpsession-0.1/tpsession/tpsession/tpsession.pro.user b/tpsession-0.1/tpsession/tpsession/tpsession.pro.user deleted file mode 100644 index ef59717..0000000 --- a/tpsession-0.1/tpsession/tpsession/tpsession.pro.user +++ /dev/null @@ -1,177 +0,0 @@ - - - - RunConfiguration0-Arguments - - - - RunConfiguration0-Executable - - - - RunConfiguration0-RunConfiguration.name - Custom Executable - - - RunConfiguration0-WorkingDirectory - $BUILDDIR - - - RunConfiguration0-type - ProjectExplorer.CustomExecutableRunConfiguration - - - activeRunConfiguration - 0 - - - activebuildconfiguration - Debug - - - buildConfiguration-Debug - - Debug - 0 - /Users/kate/scratchbox/fremantle/tpsession/tpsession/tpsession - - - - buildConfiguration-Release - - Release - 0 - - - - buildconfiguration-Debug-buildstep0 - - Debug - - - - buildconfiguration-Debug-buildstep1 - - Debug - 10 - - - - buildconfiguration-Debug-buildstep2 - - Debug - - debug - - - - - buildconfiguration-Debug-cleanstep0 - - Debug - - - - buildconfiguration-Debug-cleanstep1 - - Debug - - - - buildconfiguration-Release-buildstep0 - - Release - - - - buildconfiguration-Release-buildstep1 - - Release - 8 - - - - buildconfiguration-Release-buildstep2 - - Release - - release - - - - - buildconfiguration-Release-cleanstep0 - - Release - - - - buildconfiguration-Release-cleanstep1 - - Release - - - - buildconfigurations - - Debug - Release - - - - buildstep0 - - - - - - buildstep1 - - - - - - - buildstep2 - - - - - - buildsteps - - trolltech.qt4projectmanager.gdbmaros - trolltech.qt4projectmanager.qmake - trolltech.qt4projectmanager.make - - - - cleanstep0 - - - true - - - - cleanstep1 - - - true - - - - cleansteps - - trolltech.qt4projectmanager.gdbmaros - trolltech.qt4projectmanager.make - - - - defaultFileEncoding - System - - - project - - - diff --git a/tpsession-0.1/tpsession/tpsessionaccount.cpp b/tpsession-0.1/tpsession/tpsessionaccount.cpp index 880578a..2c0668a 100644 --- a/tpsession-0.1/tpsession/tpsessionaccount.cpp +++ b/tpsession-0.1/tpsession/tpsessionaccount.cpp @@ -21,6 +21,44 @@ #include "tpsessionaccount.h" #include +/** + * \class TpSessionAccount + * \headerfile + * + * TpSessionAccount class represents every account you have. As example account for “Ring” connection manager represents your cellular + * account and you may send and receive SMS with it. Gabble represents your GoogleTalk account if you have defined them. + * TpSessionAccounts are created by TpSession class,they are not intended to be created stand-alone + + */ +/** + * \fn void TpSessionAccount::accountReady(TpSessionAccount *); + * + * Emitted when the account becomes ready + * + * \param TpSessionAccount pointer to account become ready + */ +/** + * \fn void TpSessionAccount::channelReady(TpSessionAccount *); + * + * Emitted when the account Manager becomes ready + * + * \param TpSession pointer to TpSession class + */ +/** + * \fn void TpSessionAccount::messageReceived(const Tp::ReceivedMessage &,TpSessionAccount *); + * + * Emitted when any of Account Managers recived message + * + * \param Tp::ReceivedMessage Message received + * \param TpSessionAccount pointer to account received message + */ + +/** + * Construct a new TpSessionAccount object. This constructor is called by TpSession class when new account is created or fetched from account manager. It is not inended to be used stand alone + * + * \param am Telepathy-Qt4 account manager for this account + * \param objectPath Dbus object path tonew account + */ TpSessionAccount::TpSessionAccount(Tp::AccountManagerPtr am,const QString &objectPath): mAcc(Tp::Account::create(am->dbusConnection(),am->busName(), objectPath)) @@ -92,6 +130,16 @@ void TpSessionAccount::onContactsConnectionReady(Tp::PendingOperation *op) emit accountReady(this); } + +/** + * Fetch Tp::ContactPtr for contact with given address. Contact is searched among contacts returned by contact manager for ths account. + * All connecions managers does not return contacts, as example Ring telephony contact manager does not. Gabble for Googletalk or Spirit for Skype does + * return contacts- + * + * \param id Contact address/id, as example email address, telephone number etc. Only exact matches + * \return TpContactPtr, if nontact is not returned TpContactPtr.isNull() is true + */ + Tp::ContactPtr TpSessionAccount::getContactFromAddress(QString id) { Tp::ContactPtr p; @@ -100,6 +148,13 @@ Tp::ContactPtr TpSessionAccount::getContactFromAddress(QString id) } return p; } +/** + * Fetch TpSessionChannel for with given address. Contact is searched among active channels for this account. + * + * + * \param id Contact address/id, as example email address, telephone number etc. Only exact matches + * \return Pointer to TpSessionChannel or NULL if nit found + */ TpSessionChannel* TpSessionAccount::getChannelFromPeerAddress(QString id) { @@ -109,6 +164,11 @@ TpSessionChannel* TpSessionAccount::getChannelFromPeerAddress(QString id) } return p; } +/** + * Creates new contact with given address. This function is Acynchronous, it sends request to contact manager for contact creation, + * + * \param address Contact address/id, as example email address, telephone number etc. + */ void TpSessionAccount::makeContactFromAddress(QString address) { @@ -131,6 +191,18 @@ void TpSessionAccount::onNewContactRetrieved(Tp::PendingOperation *op) qDebug() << "TpSessionAccount::onContactRetrieved" << reqContact; if(!reqContact.isEmpty()) addOutgoingChannel(contacts.first()); } +/** + * Send message to given address. This function is compled Acynchronous function that may produce multiple state transitions beforecomletion. + * If there is already existing TpSessionChannel for this contact, it simply queues message for sending and no forther transitions are needed + * If there are no hannel, it first check is there contact for this address, if is, it requests new channel to be created for ths channel and message + * is left waiting untill channel is created. If there is no contact, it sends request fr contact creation and when contact is created state machine + * proceeds to channel creation. + * + * MessageSent() signal is emitted when completed + * + * \param address Contact address/id, as example email address, telephone number etc. + * \param message Message string + */ void TpSessionAccount::sendMessageToAddress(QString address,QString message) { @@ -175,6 +247,7 @@ void TpSessionAccount::onOutgoingChannelReady(TpSessionChannel *ch) void TpSessionAccount::onMessageSent(const Tp::Message &msg,Tp::MessageSendingFlags, const QString &flags) { qDebug() << "TpSessionAccount::onMessageSent"; + emit messageSent(msg,this); }; void TpSessionAccount::onMessageReceived(const Tp::ReceivedMessage &msg,TpSessionChannel *ch) @@ -190,19 +263,23 @@ void TpSessionAccount::onNewChannels(const Tp::ChannelDetailsList &channels) qDebug() << "TpSessionAccount::onNewChannels"; foreach (const Tp::ChannelDetails &details, channels) { QString channelType = details.properties.value(QLatin1String(TELEPATHY_INTERFACE_CHANNEL ".ChannelType")).toString(); + QString targetId = details.properties.value(QLatin1String(TELEPATHY_INTERFACE_CHANNEL ".TargetID")).toString(); bool requested = details.properties.value(QLatin1String(TELEPATHY_INTERFACE_CHANNEL ".Requested")).toBool(); - qDebug() << " channelType:" << channelType; - qDebug() << " requested :" << requested; + qDebug() << " channelType:" << channelType <<" requested :" << requested << " targetId" << targetId; + emit newChannel(this,channelType,targetId,details); if (channelType == TELEPATHY_INTERFACE_CHANNEL_TYPE_TEXT && !requested) { - myIngoingTextChannel = Tp::TextChannel::create(acc->connection(),details.channel.path(),details.properties); - qDebug() << "TpSessionAccount::onNewChannels path=" <<"path " << myIngoingTextChannel->objectPath(); + myIngoingTextChannel = Tp::TextChannel::create(acc->connection(),details.channel.path(),details.properties); + qDebug() << "TpSessionAccount::onNewChannels path=" <<"path " << myIngoingTextChannel->objectPath(); - TpSessionChannel* newChannel=new TpSessionChannel( myIngoingTextChannel); - connect(newChannel,SIGNAL(messageReceived(const Tp::ReceivedMessage &,TpSessionChannel *)), + TpSessionChannel* newChannel=new TpSessionChannel( myIngoingTextChannel); + connect(newChannel,SIGNAL(messageReceived(const Tp::ReceivedMessage &,TpSessionChannel *)), SLOT(onMessageReceived(const Tp::ReceivedMessage &,TpSessionChannel *))); - myChannels+=newChannel; - } + myChannels+=newChannel; + } + if (channelType == TELEPATHY_INTERFACE_CHANNEL_TYPE_STREAMED_MEDIA && !requested) { + qDebug() << "Incoming call" ; + } } } diff --git a/tpsession-0.1/tpsession/tpsessionaccount.h b/tpsession-0.1/tpsession/tpsessionaccount.h index ccb84fa..b6b258b 100644 --- a/tpsession-0.1/tpsession/tpsessionaccount.h +++ b/tpsession-0.1/tpsession/tpsessionaccount.h @@ -55,6 +55,8 @@ signals: void accountReady(TpSessionAccount *); void channelReady(TpSessionAccount *); void messageReceived(const Tp::ReceivedMessage &,TpSessionAccount *); + void messageSent(const Tp::Message &,TpSessionAccount *); + void newChannel(TpSessionAccount *,QString,QString,const Tp::ChannelDetails &); private slots: void onReady(Tp::PendingOperation *op); diff --git a/tpsession-0.1/tpsession/tpsessionchannel.cpp b/tpsession-0.1/tpsession/tpsessionchannel.cpp index 601e615..36e1b85 100644 --- a/tpsession-0.1/tpsession/tpsessionchannel.cpp +++ b/tpsession-0.1/tpsession/tpsessionchannel.cpp @@ -20,6 +20,57 @@ */ #include "tpsessionchannel.h" + +/** + * \class TpSessionChannel + * \headerfile + * + * + * When you start chat session or call with your buddy, channel is established with your buddy. + * TpSessionChannel represents this connection. TpSession account makes automatically channel when + * you send message to your buddy's address. If you send successive messages to same buddy with + * TpSessionAccount, it automatically reuses existing connection. + */ +/** + * \fn void TpSessionChannel::channelReady(TpSessionChannel *); + * + * Emitted when the channel becomes ready + * + * \param TpSessionChannel pointer to channel become ready + */ +/** + * \fn void TpSessionChannel::channelDestroyed(TpSessionChannel *); + * + * Emitted when the channel is destroyed + * + * \param TpSessionChannel pointer to channel destroyed. The pointer is only for referenc to remove + * it from some possible places where it could be stored. It is not guaranteed to point any more valid TpSessionChannel object + */ +/** + * \fn void TpSessionChannel::messageReceived(const Tp::ReceivedMessage &,TpSessionConnection *); + * + * Emitted when any of Account Managers recived message + * + * \param Tp::ReceivedMessage Message received + * \param TpSessionChannel pointer to channel received message + */ +/** + * \fn void TpSessionChannel::messageSent(const Tp::Message &,Tp::MessageSendingFlags, const QString &,TpSessionChannel *); + * + * \param Tp::Message message sent + */ + +/** + * Construct a new TpSessionChannel object. This constructor is called by TpSessionAccount class when + * new channel is created . It is not inended to be used stand alone + * This varient with connection and contact as parameter is intented for creationg new connection from origginator side to your peer + * + * + * \param conn connection where this channel is created + * \param contact Contacto to your peer to establish channel + */ + + TpSessionChannel::TpSessionChannel(Tp::ConnectionPtr conn,const Tp::ContactPtr &contact) { QVariantMap request; @@ -37,6 +88,14 @@ TpSessionChannel::TpSessionChannel(Tp::ConnectionPtr conn,const Tp::ContactPtr & peerContact=contact; } +/** + * Construct a new TpSessionChannel object. This constructor is called by TpSessionAccount class when + * new channel is created . It is not inended to be used stand alone + * This varient with connection only parameter is intented for receiving new connection from your peer + * + * + * \param conn connection where this channel is created + */ TpSessionChannel::TpSessionChannel(Tp::TextChannelPtr ch) @@ -76,6 +135,7 @@ void TpSessionChannel::onChannelReady(Tp::PendingOperation *op) connect(channel.data(), SIGNAL(messageSent(const Tp::Message &,Tp::MessageSendingFlags, const QString &)), SLOT(onMessageSent(const Tp::Message &,Tp::MessageSendingFlags, const QString &))); + connect(channel.data(),SIGNAL(destroyed(QObject *)),SLOT(onChannelDestroyed(QObject *))); emit channelReady(this); peerContact=channel->initiatorContact(); QList queuedMessages = channel->messageQueue(); @@ -84,6 +144,13 @@ void TpSessionChannel::onChannelReady(Tp::PendingOperation *op) emit messageReceived(message,this); } } +/** + * Send message to to ths channel + * + * + * \param message message to send + */ + void TpSessionChannel::sendMessage(QString message) { channel->send(message); @@ -98,8 +165,21 @@ void TpSessionChannel::onMessageSent(const Tp::Message &msg,Tp::MessageSendingFl qDebug() << "TpSessionChannel::onMessageSent"; emit messageSent(msg,sflags,flags,this); }; - +/** + * Get id ( address of your peer ) + * + * + * \returns your peer id/address ir empty QString + */ QString TpSessionChannel::peerId() { return peerContact ? peerContact->id():""; } + +void TpSessionChannel::onChannelDestroyed(QObject *obj) +{ + qDebug() << "TpSessionChannel::onChannelDestroyed"; + //TpSessionChannel *call = (TpSessionChannel *) obj; + emit channelDestroyed(this); +} + diff --git a/tpsession-0.1/tpsession/tpsessionchannel.h b/tpsession-0.1/tpsession/tpsessionchannel.h index e520522..cf71af0 100644 --- a/tpsession-0.1/tpsession/tpsessionchannel.h +++ b/tpsession-0.1/tpsession/tpsessionchannel.h @@ -43,11 +43,13 @@ public: QString peerId(); signals: void channelReady(TpSessionChannel *); + void channelDestroyed(TpSessionChannel *); void messageReceived(const Tp::ReceivedMessage &,TpSessionChannel *); void messageSent(const Tp::Message &,Tp::MessageSendingFlags, const QString &,TpSessionChannel *); public slots: void onChannelCreated(Tp::PendingOperation *op); void onChannelReady(Tp::PendingOperation *op); + void onChannelDestroyed(QObject *); void onMessageReceived(const Tp::ReceivedMessage &); void onMessageSent(const Tp::Message &,Tp::MessageSendingFlags, const QString &); public: diff --git a/www/MaemoTelepathy.html b/www/MaemoTelepathy.html new file mode 100644 index 0000000..94484dc --- /dev/null +++ b/www/MaemoTelepathy.html @@ -0,0 +1,36 @@ + + +- no title specified

Using Maemo 5 telephony and messaging services

TpSession Easy to Use messaging library

V 0.2

 

Kate Alhola  

kate.alhola@nokia.com

 

Basic concepts

 

Maemo 5 telephony and messaging service is based on Telepathy framework   http://telepathy.freedesktop.org/wiki/FrontPage   . Telepathy is itself just a framework defining API's between applications using services and Connection Managers handling communication for different providers.   Telepathy provides very powerful but not so easy to use API. TpSession library provides simplified layer top of Telepathy with easy to use API. TpSession is not abstraction layer that tries to hide Telepathy-Qt4 API, it just provides simple methods to perform most common use cases. At the moment, TpSession is early proof of concept and it is missing lot of features. Current version only supports textual SMS and IM with any of Telepathy connection Managers. When TpSession is not abstratction layer, it is not cross platform for non telepathy environments. Qt Mobility will be cross platform abstraction layer and TpSession is candidate to be used as internal adaptation layer for Qt Mobility.  

Connection Manager

 

Connection Manager implements certain protocol towards network service and offers Tepelathy Dbus API to system.  As example in Maemo 5, there is connection manager named Cabble handling Googletalk's XMPP protocol, Ring for cellular telephony, Sofia for SIP VoIP telephony, Spirit for Skype. You can add new protocols by just adding new connection managers, as example you can add Idle connection manager for IRC.   If you would like to implement new you need to write new connection manager to support it and for Maemo 5 you need also control panel plugin to set up account.

 

Account

 

Account defines your service provider, your user name in that service, your authentication crentials and other protocol dependent parameters like server address, port, used encryption.

 

Account Manager

 

Account Manager maintains data base of your accounts and keeps track their status. As example, you will be logged in mobile telephone network when device is switched on and online. You may also set that you are logged in you GoogleTalk and Skype accounts when device is online.   To establish connection to service client application should require your account from account manager.

 

Client applications

 

Application that uses services provided by Telepathy connection managers. As example chat client or phone user interface are telepathy clients. If you implement application that sends your current GPS location to your friend with instant message or SMS, it could be telepathy client.

 

Service Provider

 

Ad example your mobile operator or GoogleTalk or Skype service. It can be even your own IRC server.

Connection

 

To be able to use services provided by service provider, connection manager should establish connection with it. To set up connection client application should provide all needed details to connection manager, as example network address of the server, your login name and password. In case of account manager, client application will get account details from AM. If your account is set to be automatically connected, there may be also connection already established and client application should only retrieve it from AM.  It is not technically mandatory to use accounts provided by AM and it is possible set up own connection with own details if needed. In most of cases this is not recommended because it may confuse users and spoil their user experience. In cellular, there is only default connection and you need require it from CM

 

Channel

 

Channel is communication stream between you client application and your peer. It can be audio or multimedia call, chat connection, instant message connection or file transfer.  Channel may go directly from you local connection manager to peer's system or it may go via service providers server but to clint application it looks like just connection between client and peer. To set up channel your client should provide contact address, as example username or telephone number of your peer and request connection from connection manager.

 

It is possible to use as example Googletalk connection manager without using services provided by mission control if you provide account details yourself but then you are not working with same account than device user has specified for his/her use as default. For user experience, using account provided by mission control is goof idea. In cellular, it is not possible to have multiple simultaneous cellular accounts and therefore using mission control is mandatory.

 

 

 

 

Telepathy Dbus protocol and Interface library

 

Telepathy communication protocols are implemented in connection managers that are communicating using Dbus with user applications. In most cases it is not sense to use directly dbus API for user applications. There couple of Telepathy interface libraries providing API classes to user application and implementing Dbus messaging. In this example we use Telepathy-Qt4 library that is providing Qt API. There is also Glib style telepathy-glib API library.

 

Telepathy is based on communication over Dbus with connection managers running as separate processes.  Many actions need communication with server or with peer over external network. Operations with telepathy are asynchronous as nature even function call returns immediately, actual result comes much later as form of Qt signal or callback in some other platforms. Most of actions implemented with telepathy needs multiple asynchronous steps and some kind of  state machine functionality.

 

Using Telepathy via API library still needs deep understanding how telepathy works and coding is challenging task. In this example I provide simplified easy API layer as example code.

 

For future applications best solution would be to use services via Qt-Mobility libraries. With Qt mobility we can get cross platform compatibility also to non-telepathy and non-Linux environments ,as example for Series 60  

 

Synchronous or asynchronous ?

Telpathy works with synchronous interface. That mean's that all actions are initiated by function call and signal is emitted when action is complete. User application should then implement state machine logic that based on slots called by signals, progress to next state and initiate successive actions.  The positive thing in synchronous model is that it dies nit hang user interface in any cases even if completing operation takes time.

 

TpSession hides part of this complexity. Many actions implements multiple state transitions before they return signal of completed operation. TpSession implements synchronous mode in some operations, as example in class initialization where is multiple short transitions over Dbus. When initialization is called with synchronous mode, call returns after all transitions are done and completing signal is received.

 

TpSession API library

 

TpSession API library is at the moment experimental proof of concept library top of Telepathy-Qt4. It's main intention is to provide simplified API for most common services provided by telepathy, It does not try to provide any kind of data abstraction or hide Telepathy-Qt4 API inside of it. Basic functionality can be accessed without using  any of complicated Telepathy-Qt4 API's but if application needs some more advanced features, they can freely access Telepathy-Qt4 classes inside of TpSession Classes.

 

How to start

Minimum that your application needs to send SMS or Instant message is instance of TpSession class  with prefered connection manager “ring” specified and synchronous mode  specified in in constructor

 

 TpSession* tps =new TpSession("ring",true);

 tps->sendMessageToAddress("ring",”+555666777”,”Telepathy session is for you”);

 

 

 If you would also receive messages, you need to connect one slot handler for sending  for received message.

 connect(tps,SIGNAL(messageReceived(const Tp::ReceivedMessage &,TpSessionAccount *)),

             SLOT(onMessageReceived(const Tp::ReceivedMessage &,TpSessionAccount *)));

 

....

2010-01-22T10:44:44

<!--StartFragment-->

void TestProg::onMessageReceived(const Tp::ReceivedMessage &msg,TpSessionAccount *acc)

{

  qDebug() << "MessageReceived " << msg.text() << "from " << msg.sender()->id();

}

2010-01-22T10:44:44

<!--EndFragment-->

2010-01-21T23:45:35

<!--EndFragment-->

 

You will find full example code from tests/syncsms directory

 

TpSession classes

 

TpSession(QString account,bool synchronous=false)

 

Top level class, counterpart of Account Manager. TpSession connects to account manager and requests accounts from it. TpSession creates TpSessionAccount for all accounts . As top level class TpSession provides simple but somehow limited interface to send and receive messages via any account. TpSession provides signal when it has accounts ready. If you require some specific account in constructor, you will receive signal only when this account is ready. If you use constructor without any parameters, you will get one signal for every account.  If synchronous is true, constructor is executed as synchronous and it does return after transactions to set up accounts are done.

TpSessionAccount

 

TpSessionAccount class represents every account you have. As example account for “Ring” connection manager represents your cellular account and you may send and receive SMS with it. Gabble represents your GoogleTalk account if you have defined them.  

 

TpSessionConnection

 

When you start chat session or call with your buddy, connection is established. TpSessionConnection represents this connection. TpSession account makes automatically connection when you send message to your buddy's address. If you send successive messages to same buddy with TpSessionAccount, it automatically reuses existing connection.

 

 

 

 

----- The next one describes internal operation of TpSession ----

 

 

 

How it works

 

This describes, how my API library works. If you just plan use it as it is, you don't need

look it in deep as details. If you plan implement function by your own code then understanding all functionality is necessary.

 

First step, we need to establish connection with Mission control.  

 

mAM = Tp::AccountManager::create();

 

Mission Control emits signal when connection with account manager is created, it also emits signal later if new accounts are created.

 

connect(mAM->becomeReady(),SIGNAL(finished(Tp::PendingOperation *)),

                           SLOT(onAMReady(Tp::PendingOperation *)));

connect(mAM.data(),SIGNAL(accountCreated(const QString &)),

                   SLOT(onAccountCreated(const QString &)));

 

When we have connection with Account Manager, we have Dbus paths available  to account. Dbus path itself contains as part, several properties like connection manager used, protocol and user name in service if needed.

To get more details of  we need to request accounts creating Tp::AcountPtr object. When this object becomes ready, it emits finished signal. When we receive signal, we can get actual account

Tp::account * acc = mAcc.data();

 

Now, when we have actual account, we can ask several properties from account.

 

More to come  .....

\ No newline at end of file diff --git a/www/Telepathy-diag.png b/www/Telepathy-diag.png new file mode 100644 index 0000000..5253bc1 Binary files /dev/null and b/www/Telepathy-diag.png differ diff --git a/www/doxygen/annotated.html b/www/doxygen/annotated.html new file mode 100644 index 0000000..d871548 --- /dev/null +++ b/www/doxygen/annotated.html @@ -0,0 +1,46 @@ + + + + + tpsession: Class List + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + + +
+

Class List

Here are the classes, structs, unions and interfaces with brief descriptions: + + + + +
TpSession
TpSessionAccount
TpSessionChannel
TpSessionObserver
+
+

+ + + +
Copyright © 2010 Nokia Corporation
TpSession
+ + diff --git a/www/doxygen/classTpSession-members.html b/www/doxygen/classTpSession-members.html new file mode 100644 index 0000000..a5832db --- /dev/null +++ b/www/doxygen/classTpSession-members.html @@ -0,0 +1,52 @@ + + + + + tpsession: Member List + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + + +
+

TpSession Member List

This is the complete list of members for TpSession, including all inherited members.

+ + + + + + + + + + + +
accountReady(TpSessionAccount *)TpSession [signal]
accountsTpSession
amReady(TpSession *)TpSession [signal]
channeReady(TpSessionAccount *)TpSession [signal]
createChannelListener(const QString &channelType, const Tp::MethodInvocationContextPtr<> &context, const Tp::AccountPtr &account, const Tp::ChannelPtr &channel)TpSession
createObserver()TpSession
getAccount(const QString cm, const QString protocol=QString())TpSession
instance(bool synchronous=TRUE)TpSession [static]
messageReceived(const Tp::ReceivedMessage &, TpSessionAccount *)TpSession [signal]
sendMessageToAddress(QString connectionMgr, QString address, QString message)TpSession
TpSession(QString cmname=QString(), bool synchronous=FALSE)TpSession

+

+ + + +
Copyright © 2010 Nokia Corporation
TpSession
+ + diff --git a/www/doxygen/classTpSession.html b/www/doxygen/classTpSession.html new file mode 100644 index 0000000..fa93e02 --- /dev/null +++ b/www/doxygen/classTpSession.html @@ -0,0 +1,395 @@ + + + + + tpsession: TpSession Class Reference + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + + +
+

TpSession Class Reference

#include <tpsession.h> +

+ +

+List of all members.

Signals

+ +

Public Member Functions

+ +

Static Public Member Functions

+ +

Public Attributes

+ +

Detailed Description

+Top level class, counterpart of Account Manager. TpSession connects to account manager and requests accounts from it. TpSession creates TpSessionAccount for all accounts . As top level class TpSession provides simålified interface to send and receive messages via any account. TpSession provides signal when it has accounts ready. If you require some specific account in constructor, you will receive signal only when this account is ready. If you use constructor without any parameters, you will get one signal for every account. If synchronous is true, constructor is executed as synchronous and it does return after transactions to set up accounts are done.

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
TpSession (QString  cmname = QString(),
bool  synchronous = FALSE 
)
+
+
+ +

+Construct a new TpSession object.

+

Parameters:
+ + + +
cmname Name of the default connection manager. Can be empty or omnitted, then there is no default connection manager
synchronous if false, asynchronous behavior, function returns immediately and accountReady signals are emitted when accounts are ready if True, synchronous behavior and function returns when accounts are ready
+
+ +
+

+

Member Function Documentation

+ +
+
+ + + + + + + + + +
TpSession * instance (bool  synchronous = TRUE  )  [static]
+
+
+ +

+Returns pointer to TpSession singleton. If there is not yet TpSession Object, creates it with "Ring" connection manager as default

+

Parameters:
+ + +
synchronous if false, asynchronous behavior, function returns immediately and accountReady signals are emitted when accounts are ready if True, synchronous behavior and function returns when accounts are ready
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void sendMessageToAddress (QString  connectionMgr,
QString  address,
QString  message 
)
+
+
+ +

+Send message using specified connection manager to address

+

Parameters:
+ + + + +
connectionMgr Name of the connection manager
address Valid address for this connection manager type. Asexample telephone number to Ring, GoogleTalk address for Gabble
message Message body
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
TpSessionAccount * getAccount (const QString  cm,
const QString  protocol = QString() 
)
+
+
+ +

+Returns pointer to TpSessionAccout object with specified connection manager or protocol, returns NULL if no match found

+

Parameters:
+ + + +
cm Name of the connection manager, if left empty matches every entry
protocol Name of the protocol manager, if left empty matches every entry
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void createChannelListener (const QString &  channelType,
const Tp::MethodInvocationContextPtr<> &  context,
const Tp::AccountPtr &  account,
const Tp::ChannelPtr &  channel 
)
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + +
void createObserver (  ) 
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
void amReady (TpSession *  _t1  )  [signal]
+
+
+ +

+Emitted when the account Manager becomes ready

+

Parameters:
+ + +
TpSession pointer to TpSession class
+
+ +
+

+ +

+
+ + + + + + + + + +
void accountReady (TpSessionAccount *  _t1  )  [signal]
+
+
+ +

+Emitted when the account becomes ready

+

Parameters:
+ + +
TpSessionAccount pointer to account become ready
+
+ +
+

+ +

+
+ + + + + + + + + +
void channeReady (TpSessionAccount *  _t1  )  [signal]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void messageReceived (const Tp::ReceivedMessage &  _t1,
TpSessionAccount *  _t2 
) [signal]
+
+
+ +

+Emitted when any of Account Managers recived message

+

Parameters:
+ + + +
Tp::ReceivedMessage Message received
TpSessionAccount pointer to account received message
+
+ +
+

+

Member Data Documentation

+ +
+
+ + + + +
QVector<TpSessionAccount*> accounts
+
+
+ +

+ +

+

+

+

+ + + +
Copyright © 2010 Nokia Corporation
TpSession
+ + diff --git a/www/doxygen/classTpSessionAccount-members.html b/www/doxygen/classTpSessionAccount-members.html new file mode 100644 index 0000000..f8e804b --- /dev/null +++ b/www/doxygen/classTpSessionAccount-members.html @@ -0,0 +1,61 @@ + + + + + tpsession: Member List + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + + +
+

TpSessionAccount Member List

This is the complete list of members for TpSessionAccount, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + +
accTpSessionAccount
accountReady(TpSessionAccount *)TpSessionAccount [signal]
addOutgoingChannel(const Tp::ContactPtr &contact)TpSessionAccount
addOutgoingChannel(QString address)TpSessionAccount
channelReady(TpSessionAccount *)TpSessionAccount [signal]
contactsConnTpSessionAccount
getChannelFromPeerAddress(QString id)TpSessionAccount
getContactFromAddress(QString address)TpSessionAccount
mAccTpSessionAccount
makeContactFromAddress(QString address)TpSessionAccount
messageReceived(const Tp::ReceivedMessage &, TpSessionAccount *)TpSessionAccount [signal]
messageSent(const Tp::Message &, TpSessionAccount *)TpSessionAccount [signal]
myChannelsTpSessionAccount
myContactsTpSessionAccount
newChannel(TpSessionAccount *, QString, QString, const Tp::ChannelDetails &)TpSessionAccount [signal]
readyTpSessionAccount
reqContactTpSessionAccount
reqMessageTpSessionAccount
sendMessageToAddress(QString address, QString message)TpSessionAccount
TpSessionAccount(Tp::AccountManagerPtr am, const QString &objectPath)TpSessionAccount

+

+ + + +
Copyright © 2010 Nokia Corporation
TpSession
+ + diff --git a/www/doxygen/classTpSessionAccount.html b/www/doxygen/classTpSessionAccount.html new file mode 100644 index 0000000..7cc10ac --- /dev/null +++ b/www/doxygen/classTpSessionAccount.html @@ -0,0 +1,548 @@ + + + + + tpsession: TpSessionAccount Class Reference + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + + +
+

TpSessionAccount Class Reference

#include <tpsessionaccount.h> +

+ +

+List of all members.

Signals

+ +

Public Member Functions

+ +

Public Attributes

+ +

Detailed Description

+TpSessionAccount class represents every account you have. As example account for “Ring” connection manager represents your cellular account and you may send and receive SMS with it. Gabble represents your GoogleTalk account if you have defined them. TpSessionAccounts are created by TpSession class,they are not intended to be created stand-alone

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
TpSessionAccount (Tp::AccountManagerPtr  am,
const QString &  objectPath 
)
+
+
+ +

+Construct a new TpSessionAccount object. This constructor is called by TpSession class when new account is created or fetched from account manager. It is not inended to be used stand alone

+

Parameters:
+ + + +
am Telepathy-Qt4 account manager for this account
objectPath Dbus object path tonew account
+
+ +
+

+

Member Function Documentation

+ +
+
+ + + + + + + + + +
void makeContactFromAddress (QString  address  ) 
+
+
+ +

+Creates new contact with given address. This function is Acynchronous, it sends request to contact manager for contact creation,

+

Parameters:
+ + +
address Contact address/id, as example email address, telephone number etc.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void sendMessageToAddress (QString  address,
QString  message 
)
+
+
+ +

+Send message to given address. This function is compled Acynchronous function that may produce multiple state transitions beforecomletion. If there is already existing TpSessionChannel for this contact, it simply queues message for sending and no forther transitions are needed If there are no hannel, it first check is there contact for this address, if is, it requests new channel to be created for ths channel and message is left waiting untill channel is created. If there is no contact, it sends request fr contact creation and when contact is created state machine proceeds to channel creation.

+MessageSent() signal is emitted when completed

+

Parameters:
+ + + +
address Contact address/id, as example email address, telephone number etc.
message Message string
+
+ +
+

+ +

+
+ + + + + + + + + +
Tp::ContactPtr getContactFromAddress (QString  id  ) 
+
+
+ +

+Fetch Tp::ContactPtr for contact with given address. Contact is searched among contacts returned by contact manager for ths account. All connecions managers does not return contacts, as example Ring telephony contact manager does not. Gabble for Googletalk or Spirit for Skype does return contacts-

+

Parameters:
+ + +
id Contact address/id, as example email address, telephone number etc. Only exact matches
+
+
Returns:
TpContactPtr, if nontact is not returned TpContactPtr.isNull() is true
+ +
+

+ +

+
+ + + + + + + + + +
void addOutgoingChannel (const Tp::ContactPtr &  contact  ) 
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
void addOutgoingChannel (QString  address  ) 
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
TpSessionChannel * getChannelFromPeerAddress (QString  id  ) 
+
+
+ +

+Fetch TpSessionChannel for with given address. Contact is searched among active channels for this account.

+

Parameters:
+ + +
id Contact address/id, as example email address, telephone number etc. Only exact matches
+
+
Returns:
Pointer to TpSessionChannel or NULL if nit found
+ +
+

+ +

+
+ + + + + + + + + +
void accountReady (TpSessionAccount *  _t1  )  [signal]
+
+
+ +

+Emitted when the account becomes ready

+

Parameters:
+ + +
TpSessionAccount pointer to account become ready
+
+ +
+

+ +

+
+ + + + + + + + + +
void channelReady (TpSessionAccount *  _t1  )  [signal]
+
+
+ +

+Emitted when the account Manager becomes ready

+

Parameters:
+ + +
TpSession pointer to TpSession class
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void messageReceived (const Tp::ReceivedMessage &  _t1,
TpSessionAccount *  _t2 
) [signal]
+
+
+ +

+Emitted when any of Account Managers recived message

+

Parameters:
+ + + +
Tp::ReceivedMessage Message received
TpSessionAccount pointer to account received message
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void messageSent (const Tp::Message &  _t1,
TpSessionAccount *  _t2 
) [signal]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void newChannel (TpSessionAccount *  _t1,
QString  _t2,
QString  _t3,
const Tp::ChannelDetails &  _t4 
) [signal]
+
+
+ +

+ +

+

+

Member Data Documentation

+ +
+
+ + + + +
bool ready
+
+
+ +

+ +

+

+ +

+
+ + + + +
QString reqContact
+
+
+ +

+ +

+

+ +

+
+ + + + +
QString reqMessage
+
+
+ +

+ +

+

+ +

+
+ + + + +
Tp::AccountPtr mAcc
+
+
+ +

+ +

+

+ +

+
+ + + + +
Tp::Account* acc
+
+
+ +

+ +

+

+ +

+
+ + + + +
Tp::ConnectionPtr contactsConn
+
+
+ +

+ +

+

+ +

+
+ + + + +
QSet<Tp::ContactPtr> myContacts
+
+
+ +

+ +

+

+ +

+
+ + + + +
QSet<TpSessionChannel *> myChannels
+
+
+ +

+ +

+

+

+

+ + + +
Copyright © 2010 Nokia Corporation
TpSession
+ + diff --git a/www/doxygen/classTpSessionChannel-members.html b/www/doxygen/classTpSessionChannel-members.html new file mode 100644 index 0000000..521303d --- /dev/null +++ b/www/doxygen/classTpSessionChannel-members.html @@ -0,0 +1,56 @@ + + + + + tpsession: Member List + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + + +
+

TpSessionChannel Member List

This is the complete list of members for TpSessionChannel, including all inherited members.

+ + + + + + + + + + + + + + + +
channelTpSessionChannel
channelDestroyed(TpSessionChannel *)TpSessionChannel [signal]
channelReady(TpSessionChannel *)TpSessionChannel [signal]
messageReceived(const Tp::ReceivedMessage &, TpSessionChannel *)TpSessionChannel [signal]
messageSent(const Tp::Message &, Tp::MessageSendingFlags, const QString &, TpSessionChannel *)TpSessionChannel [signal]
onChannelCreated(Tp::PendingOperation *op)TpSessionChannel [slot]
onChannelDestroyed(QObject *)TpSessionChannel [slot]
onChannelReady(Tp::PendingOperation *op)TpSessionChannel [slot]
onMessageReceived(const Tp::ReceivedMessage &)TpSessionChannel [slot]
onMessageSent(const Tp::Message &, Tp::MessageSendingFlags, const QString &)TpSessionChannel [slot]
peerContactTpSessionChannel
peerId()TpSessionChannel
sendMessage(QString message)TpSessionChannel
TpSessionChannel(Tp::TextChannelPtr)TpSessionChannel
TpSessionChannel(Tp::ConnectionPtr conn, const Tp::ContactPtr &contact)TpSessionChannel

+

+ + + +
Copyright © 2010 Nokia Corporation
TpSession
+ + diff --git a/www/doxygen/classTpSessionChannel.html b/www/doxygen/classTpSessionChannel.html new file mode 100644 index 0000000..b9d399e --- /dev/null +++ b/www/doxygen/classTpSessionChannel.html @@ -0,0 +1,456 @@ + + + + + tpsession: TpSessionChannel Class Reference + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + + +
+

TpSessionChannel Class Reference

#include <tpsessionchannel.h> +

+ +

+List of all members.

Public Slots

+ +

Signals

+ +

Public Member Functions

+ +

Public Attributes

+ +

Detailed Description

+When you start chat session or call with your buddy, channel is established with your buddy. TpSessionChannel represents this connection. TpSession account makes automatically channel when you send message to your buddy's address. If you send successive messages to same buddy with TpSessionAccount, it automatically reuses existing connection.

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + +
TpSessionChannel (Tp::TextChannelPtr  ch  ) 
+
+
+ +

+Construct a new TpSessionChannel object. This constructor is called by TpSessionAccount class when new channel is created . It is not inended to be used stand alone This varient with connection only parameter is intented for receiving new connection from your peer

+

Parameters:
+ + +
conn connection where this channel is created
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
TpSessionChannel (Tp::ConnectionPtr  conn,
const Tp::ContactPtr &  contact 
)
+
+
+ +

+Construct a new TpSessionChannel object. This constructor is called by TpSessionAccount class when new channel is created . It is not inended to be used stand alone This varient with connection and contact as parameter is intented for creationg new connection from origginator side to your peer

+

Parameters:
+ + + +
conn connection where this channel is created
contact Contacto to your peer to establish channel
+
+ +
+

+

Member Function Documentation

+ +
+
+ + + + + + + + + +
void sendMessage (QString  message  ) 
+
+
+ +

+Send message to to ths channel

+

Parameters:
+ + +
message message to send
+
+ +
+

+ +

+
+ + + + + + + + +
QString peerId (  ) 
+
+
+ +

+Get id ( address of your peer )

+

Returns:
your peer id/address ir empty QString
+ +
+

+ +

+
+ + + + + + + + + +
void channelReady (TpSessionChannel *  _t1  )  [signal]
+
+
+ +

+Emitted when the channel becomes ready

+

Parameters:
+ + +
TpSessionChannel pointer to channel become ready
+
+ +
+

+ +

+
+ + + + + + + + + +
void channelDestroyed (TpSessionChannel *  _t1  )  [signal]
+
+
+ +

+Emitted when the channel is destroyed

+

Parameters:
+ + +
TpSessionChannel pointer to channel destroyed. The pointer is only for referenc to remove it from some possible places where it could be stored. It is not guaranteed to point any more valid TpSessionChannel object
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void messageReceived (const Tp::ReceivedMessage &  _t1,
TpSessionChannel *  _t2 
) [signal]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void messageSent (const Tp::Message &  _t1,
Tp::MessageSendingFlags  _t2,
const QString &  _t3,
TpSessionChannel *  _t4 
) [signal]
+
+
+ +

+

Parameters:
+ + +
Tp::Message message sent
+
+ +
+

+ +

+
+ + + + + + + + + +
void onChannelCreated (Tp::PendingOperation *  op  )  [slot]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
void onChannelReady (Tp::PendingOperation *  op  )  [slot]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
void onChannelDestroyed (QObject *  obj  )  [slot]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
void onMessageReceived (const Tp::ReceivedMessage &  msg  )  [slot]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void onMessageSent (const Tp::Message &  msg,
Tp::MessageSendingFlags  sflags,
const QString &  flags 
) [slot]
+
+
+ +

+ +

+

+

Member Data Documentation

+ +
+
+ + + + +
Tp::ContactPtr peerContact
+
+
+ +

+ +

+

+ +

+
+ + + + +
Tp::TextChannelPtr channel
+
+
+ +

+ +

+

+

+

+ + + +
Copyright © 2010 Nokia Corporation
TpSession
+ + diff --git a/www/doxygen/classTpSessionObserver-members.html b/www/doxygen/classTpSessionObserver-members.html new file mode 100644 index 0000000..0c0649e --- /dev/null +++ b/www/doxygen/classTpSessionObserver-members.html @@ -0,0 +1,44 @@ + + + + + tpsession: Member List + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + + +
+

TpSessionObserver Member List

This is the complete list of members for TpSessionObserver, including all inherited members.

+ + + +
observeChannels(const Tp::MethodInvocationContextPtr<> &context, const Tp::AccountPtr &account, const Tp::ConnectionPtr &connection, const QList< Tp::ChannelPtr > &channels, const Tp::ChannelDispatchOperationPtr &dispatchOperation, const QList< Tp::ChannelRequestPtr > &requestsSatisfied, const QVariantMap &observerInfo)TpSessionObserver [virtual]
tpSessionTpSessionObserver
TpSessionObserver(const Tp::ChannelClassList &channelfilter, TpSession *session)TpSessionObserver

+

+ + + +
Copyright © 2010 Nokia Corporation
TpSession
+ + diff --git a/www/doxygen/classTpSessionObserver.html b/www/doxygen/classTpSessionObserver.html new file mode 100644 index 0000000..200d356 --- /dev/null +++ b/www/doxygen/classTpSessionObserver.html @@ -0,0 +1,161 @@ + + + + + tpsession: TpSessionObserver Class Reference + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + + +
+

TpSessionObserver Class Reference

#include <tpsessionobserver.h> +

+ +

+List of all members.

Public Member Functions

+
    +
  • TpSessionObserver (const Tp::ChannelClassList &channelfilter, TpSession *session) +
  • virtual void observeChannels (const Tp::MethodInvocationContextPtr<> &context, const Tp::AccountPtr &account, const Tp::ConnectionPtr &connection, const QList< Tp::ChannelPtr > &channels, const Tp::ChannelDispatchOperationPtr &dispatchOperation, const QList< Tp::ChannelRequestPtr > &requestsSatisfied, const QVariantMap &observerInfo) +
    Realisation of Tp::AbstractClientObserver.
+

Public Attributes

+ +

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
TpSessionObserver (const Tp::ChannelClassList &  channelfilter,
TpSession *  session 
)
+
+
+ +

+ +

+

+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void observeChannels (const Tp::MethodInvocationContextPtr<> &  context,
const Tp::AccountPtr &  account,
const Tp::ConnectionPtr &  connection,
const QList< Tp::ChannelPtr > &  channels,
const Tp::ChannelDispatchOperationPtr &  dispatchOperation,
const QList< Tp::ChannelRequestPtr > &  requestsSatisfied,
const QVariantMap &  observerInfo 
) [virtual]
+
+
+ +

+Realisation of Tp::AbstractClientObserver. +

+ +

+

+

Member Data Documentation

+ +
+
+ + + + +
TpSession* tpSession
+
+
+ +

+ +

+

+

+

+ + + +
Copyright © 2010 Nokia Corporation
TpSession
+ + diff --git a/www/doxygen/doxygen.css b/www/doxygen/doxygen.css new file mode 100644 index 0000000..c826613 --- /dev/null +++ b/www/doxygen/doxygen.css @@ -0,0 +1,429 @@ +body, table, div, p, dl { + font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; + font-size: 12px; +} + +/* @group Heading Levels */ + +h1 { + text-align: center; + font-size: 150%; +} + +h2 { + font-size: 120%; +} + +h3 { + font-size: 100%; +} + +/* @end */ + +caption { + font-weight: bold; +} + +div.qindex, div.navtab{ + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + padding: 2px; +} + +div.qindex, div.navpath { + width: 100%; + line-height: 140%; +} + +div.navtab { + margin-right: 15px; +} + +/* @group Link Styling */ + +a { + color: #153788; + font-weight: normal; + text-decoration: none; +} + +.contents a:visited { + color: #1b77c5; +} + +a:hover { + text-decoration: underline; +} + +a.qindex { + font-weight: bold; +} + +a.qindexHL { + font-weight: bold; + background-color: #6666cc; + color: #ffffff; + border: 1px double #9295C2; +} + +.contents a.qindexHL:visited { + color: #ffffff; +} + +a.el { + font-weight: bold; +} + +a.elRef { +} + +a.code { +} + +a.codeRef { +} + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +.fragment { + font-family: monospace, fixed; + font-size: 105%; +} + +pre.fragment { + border: 1px solid #CCCCCC; + background-color: #f5f5f5; + padding: 4px 6px; + margin: 4px 8px 4px 2px; +} + +div.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + margin-bottom: 6px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + background: white; + color: black; + margin-right: 20px; + margin-left: 20px; +} + +td.indexkey { + background-color: #e8eef2; + font-weight: bold; + border: 1px solid #CCCCCC; + margin: 2px 0px 2px 0; + padding: 2px 10px; +} + +td.indexvalue { + background-color: #e8eef2; + border: 1px solid #CCCCCC; + padding: 2px 10px; + margin: 2px 0px; +} + +tr.memlist { + background-color: #f0f0f0; +} + +p.formulaDsp { + text-align: center; +} + +img.formulaDsp { + +} + +img.formulaInl { + vertical-align: middle; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 +} + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +/* @end */ + +.search { + color: #003399; + font-weight: bold; +} + +form.search { + margin-bottom: 0px; + margin-top: 0px; +} + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #84b0c7; +} + +th.dirtab { + background: #e8eef2; + font-weight: bold; +} + +hr { + height: 0; + border: none; + border-top: 1px solid #666; +} + +/* @group Member Descriptions */ + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: #FAFAFA; + border: none; + margin: 4px; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: #555; +} + +.memItemLeft, .memItemRight, .memTemplParams { + border-top: 1px solid #ccc; +} + +.memTemplParams { + color: #606060; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtemplate { + font-size: 80%; + color: #606060; + font-weight: normal; + margin-left: 3px; +} + +.memnav { + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.memitem { + padding: 0; +} + +.memname { + white-space: nowrap; + font-weight: bold; +} + +.memproto { + padding: 0; + background-color: #d5e1e8; + font-weight: bold; + border: 1px solid #84b0c7; +} + +.memdoc { + padding: 2px 5px; + border-top-width: 0; +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #602020; + white-space: nowrap; +} +.paramname em { + font-style: normal; +} + +/* @end */ + +/* @group Directory (tree) */ + +/* for the tree view */ + +.ftvtree { + font-family: sans-serif; + margin: 0.5em; +} + +/* these are for tree view when used as main index */ + +.directory { + font-size: 9pt; + font-weight: bold; +} + +.directory h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +/* +The following two styles can be used to replace the root node title +with an image of your choice. Simply uncomment the next two styles, +specify the name of your image and be sure to set 'height' to the +proper pixel height of your image. +*/ + +/* +.directory h3.swap { + height: 61px; + background-repeat: no-repeat; + background-image: url("yourimage.gif"); +} +.directory h3.swap span { + display: none; +} +*/ + +.directory > h3 { + margin-top: 0; +} + +.directory p { + margin: 0px; + white-space: nowrap; +} + +.directory div { + display: none; + margin: 0px; +} + +.directory img { + vertical-align: -30%; +} + +/* these are for tree view when not used as main index */ + +.directory-alt { + font-size: 100%; + font-weight: bold; +} + +.directory-alt h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +.directory-alt > h3 { + margin-top: 0; +} + +.directory-alt p { + margin: 0px; + white-space: nowrap; +} + +.directory-alt div { + display: none; + margin: 0px; +} + +.directory-alt img { + vertical-align: -30%; +} + +/* @end */ + +address { + font-style: normal; + color: #333; +} diff --git a/www/doxygen/doxygen.png b/www/doxygen/doxygen.png new file mode 100644 index 0000000..f0a274b Binary files /dev/null and b/www/doxygen/doxygen.png differ diff --git a/www/doxygen/files.html b/www/doxygen/files.html new file mode 100644 index 0000000..5547b94 --- /dev/null +++ b/www/doxygen/files.html @@ -0,0 +1,46 @@ + + + + + tpsession: File Index + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + + +
+

File List

Here is a list of all files with brief descriptions: + + + + +
tpsession.h [code]
tpsessionaccount.h [code]
tpsessionchannel.h [code]
tpsessionobserver.h [code]
+
+

+ + + +
Copyright © 2010 Nokia Corporation
TpSession
+ + diff --git a/www/doxygen/functions.html b/www/doxygen/functions.html new file mode 100644 index 0000000..d491be1 --- /dev/null +++ b/www/doxygen/functions.html @@ -0,0 +1,174 @@ + + + + + tpsession: Class Members + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + + +
+ +
+
+ +
+
+Here is a list of all class members with links to the classes they belong to: +

+

- a -

+

- c -

+

- g -

+

- i -

+

- m -

+

- n -

+

- o -

+

- p -

+

- r -

+

- s -

+

- t -

+
+

+ + + +
Copyright © 2010 Nokia Corporation
TpSession
+ + diff --git a/www/doxygen/functions_func.html b/www/doxygen/functions_func.html new file mode 100644 index 0000000..c833b87 --- /dev/null +++ b/www/doxygen/functions_func.html @@ -0,0 +1,147 @@ + + + + + tpsession: Class Members - Functions + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + + +
+ +
+
+ +
+
+  +

+

- a -

+

- c -

+

- g -

+

- i -

+

- m -

+

- n -

+

- o -

+

- p -

+

- s -

+

- t -

+
+

+ + + +
Copyright © 2010 Nokia Corporation
TpSession
+ + diff --git a/www/doxygen/functions_vars.html b/www/doxygen/functions_vars.html new file mode 100644 index 0000000..dcb2c85 --- /dev/null +++ b/www/doxygen/functions_vars.html @@ -0,0 +1,75 @@ + + + + + tpsession: Class Members - Variables + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + + +
+ +
+
+  +

+

+
+

+ + + +
Copyright © 2010 Nokia Corporation
TpSession
+ + diff --git a/www/doxygen/graph_legend.dot b/www/doxygen/graph_legend.dot new file mode 100644 index 0000000..1f7c6e4 --- /dev/null +++ b/www/doxygen/graph_legend.dot @@ -0,0 +1,23 @@ +digraph G +{ + bgcolor="transparent"; + edge [fontname="FreeSans",fontsize=10,labelfontname="FreeSans",labelfontsize=10]; + node [fontname="FreeSans",fontsize=10,shape=record]; + Node9 [shape="box",label="Inherited",fontsize=10,height=0.2,width=0.4,fontname="FreeSans",fillcolor="grey75",style="filled" fontcolor="black"]; + Node10 -> Node9 [dir=back,color="midnightblue",fontsize=10,style="solid",fontname="FreeSans"]; + Node10 [shape="box",label="PublicBase",fontsize=10,height=0.2,width=0.4,fontname="FreeSans",color="black",URL="$classPublicBase.html"]; + Node11 -> Node10 [dir=back,color="midnightblue",fontsize=10,style="solid",fontname="FreeSans"]; + Node11 [shape="box",label="Truncated",fontsize=10,height=0.2,width=0.4,fontname="FreeSans",color="red",URL="$classTruncated.html"]; + Node13 -> Node9 [dir=back,color="darkgreen",fontsize=10,style="solid",fontname="FreeSans"]; + Node13 [shape="box",label="ProtectedBase",fontsize=10,height=0.2,width=0.4,fontname="FreeSans",color="black",URL="$classProtectedBase.html"]; + Node14 -> Node9 [dir=back,color="firebrick4",fontsize=10,style="solid",fontname="FreeSans"]; + Node14 [shape="box",label="PrivateBase",fontsize=10,height=0.2,width=0.4,fontname="FreeSans",color="black",URL="$classPrivateBase.html"]; + Node15 -> Node9 [dir=back,color="midnightblue",fontsize=10,style="solid",fontname="FreeSans"]; + Node15 [shape="box",label="Undocumented",fontsize=10,height=0.2,width=0.4,fontname="FreeSans",color="grey75"]; + Node16 -> Node9 [dir=back,color="midnightblue",fontsize=10,style="solid",fontname="FreeSans"]; + Node16 [shape="box",label="Templ< int >",fontsize=10,height=0.2,width=0.4,fontname="FreeSans",color="black",URL="$classTempl.html"]; + Node17 -> Node16 [dir=back,color="orange",fontsize=10,style="dashed",label="< int >",fontname="FreeSans"]; + Node17 [shape="box",label="Templ< T >",fontsize=10,height=0.2,width=0.4,fontname="FreeSans",color="black",URL="$classTempl.html"]; + Node18 -> Node9 [dir=back,color="darkorchid3",fontsize=10,style="dashed",label="m_usedClass",fontname="FreeSans"]; + Node18 [shape="box",label="Used",fontsize=10,height=0.2,width=0.4,fontname="FreeSans",color="black",URL="$classUsed.html"]; +} diff --git a/www/doxygen/graph_legend.html b/www/doxygen/graph_legend.html new file mode 100644 index 0000000..c24f89c --- /dev/null +++ b/www/doxygen/graph_legend.html @@ -0,0 +1,102 @@ + + + + + tpsession: Graph Legend + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + + +
+

Graph Legend

This page explains how to interpret the graphs that are generated by doxygen.

+Consider the following example: 

/*! Invisible class because of truncation */
+class Invisible { };
+
+/*! Truncated class, inheritance relation is hidden */
+class Truncated : public Invisible { };
+
+/* Class not documented with doxygen comments */
+class Undocumented { };
+
+/*! Class that is inherited using public inheritance */
+class PublicBase : public Truncated { };
+
+/*! A template class */
+template<class T> class Templ { };
+
+/*! Class that is inherited using protected inheritance */
+class ProtectedBase { };
+
+/*! Class that is inherited using private inheritance */
+class PrivateBase { };
+
+/*! Class that is used by the Inherited class */
+class Used { };
+
+/*! Super class that inherits a number of other classes */
+class Inherited : public PublicBase,
+                  protected ProtectedBase,
+                  private PrivateBase,
+                  public Undocumented,
+                  public Templ<int>
+{
+  private:
+    Used *m_usedClass;
+};
+
If the MAX_DOT_GRAPH_HEIGHT tag in the configuration file is set to 240 this will result in the following graph:

+

+graph_legend.png +
+

+The boxes in the above graph have the following meaning:

    +
  • +A filled gray box represents the struct or class for which the graph is generated.
    • +
  • +A box with a black border denotes a documented struct or class.
    • +
  • +A box with a grey border denotes an undocumented struct or class.
    • +
  • +A box with a red border denotes a documented struct or class forwhich not all inheritance/containment relations are shown. A graph is truncated if it does not fit within the specified boundaries.
    • +
+The arrows have the following meaning:
    +
  • +A dark blue arrow is used to visualize a public inheritance relation between two classes.
    • +
  • +A dark green arrow is used for protected inheritance.
    • +
  • +A dark red arrow is used for private inheritance.
    • +
  • +A purple dashed arrow is used if a class is contained or used by another class. The arrow is labeled with the variable(s) through which the pointed class or struct is accessible.
    • +
  • +A yellow dashed arrow denotes a relation between a template instance and the template class it was instantiated from. The arrow is labeled with the template parameters of the instance.
    • +
+
+

+ + + +
Copyright © 2010 Nokia Corporation
TpSession
+ + diff --git a/www/doxygen/graph_legend.png b/www/doxygen/graph_legend.png new file mode 100644 index 0000000..2eef20a Binary files /dev/null and b/www/doxygen/graph_legend.png differ diff --git a/www/doxygen/index.html b/www/doxygen/index.html new file mode 100644 index 0000000..ae8f4ca --- /dev/null +++ b/www/doxygen/index.html @@ -0,0 +1,52 @@ + + + + + tpsession: Main Page + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + + +
+

tpsession Documentation

+

+

+ +
+

+ + + +
Copyright © 2010 Nokia Corporation
TpSession
+ + diff --git a/www/doxygen/tab_b.gif b/www/doxygen/tab_b.gif new file mode 100644 index 0000000..0d62348 Binary files /dev/null and b/www/doxygen/tab_b.gif differ diff --git a/www/doxygen/tab_l.gif b/www/doxygen/tab_l.gif new file mode 100644 index 0000000..9b1e633 Binary files /dev/null and b/www/doxygen/tab_l.gif differ diff --git a/www/doxygen/tab_r.gif b/www/doxygen/tab_r.gif new file mode 100644 index 0000000..ce9dd9f Binary files /dev/null and b/www/doxygen/tab_r.gif differ diff --git a/www/doxygen/tabs.css b/www/doxygen/tabs.css new file mode 100644 index 0000000..95f00a9 --- /dev/null +++ b/www/doxygen/tabs.css @@ -0,0 +1,102 @@ +/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ + +DIV.tabs +{ + float : left; + width : 100%; + background : url("tab_b.gif") repeat-x bottom; + margin-bottom : 4px; +} + +DIV.tabs UL +{ + margin : 0px; + padding-left : 10px; + list-style : none; +} + +DIV.tabs LI, DIV.tabs FORM +{ + display : inline; + margin : 0px; + padding : 0px; +} + +DIV.tabs FORM +{ + float : right; +} + +DIV.tabs A +{ + float : left; + background : url("tab_r.gif") no-repeat right top; + border-bottom : 1px solid #84B0C7; + font-size : x-small; + font-weight : bold; + text-decoration : none; +} + +DIV.tabs A:hover +{ + background-position: 100% -150px; +} + +DIV.tabs A:link, DIV.tabs A:visited, +DIV.tabs A:active, DIV.tabs A:hover +{ + color: #1A419D; +} + +DIV.tabs SPAN +{ + float : left; + display : block; + background : url("tab_l.gif") no-repeat left top; + padding : 5px 9px; + white-space : nowrap; +} + +DIV.tabs INPUT +{ + float : right; + display : inline; + font-size : 1em; +} + +DIV.tabs TD +{ + font-size : x-small; + font-weight : bold; + text-decoration : none; +} + + + +/* Commented Backslash Hack hides rule from IE5-Mac \*/ +DIV.tabs SPAN {float : none;} +/* End IE5-Mac hack */ + +DIV.tabs A:hover SPAN +{ + background-position: 0% -150px; +} + +DIV.tabs LI.current A +{ + background-position: 100% -150px; + border-width : 0px; +} + +DIV.tabs LI.current SPAN +{ + background-position: 0% -150px; + padding-bottom : 6px; +} + +DIV.navpath +{ + background : none; + border : none; + border-bottom : 1px solid #84B0C7; +} diff --git a/www/doxygen/tpsession_2tpsession_8h-source.html b/www/doxygen/tpsession_2tpsession_8h-source.html new file mode 100644 index 0000000..e6bcb35 --- /dev/null +++ b/www/doxygen/tpsession_2tpsession_8h-source.html @@ -0,0 +1,49 @@ + + + + + tpsession: tpsession.h Source File + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + + +

tpsession.h

00001 #ifndef TPSESSION_H
+00002 #define TPSESSION_H
+00003 
+00004 
+00005 class Tpsession {
+00006 public:
+00007     Tpsession();
+00008 };
+00009 
+00010 #endif // TPSESSION_H
+
+

+ + + +
Copyright © 2009 Collabora Ltd. and Nokia Corporation
Telepathy-Qt4
+ + diff --git a/www/doxygen/tpsession_8h-source.html b/www/doxygen/tpsession_8h-source.html new file mode 100644 index 0000000..c8df877 --- /dev/null +++ b/www/doxygen/tpsession_8h-source.html @@ -0,0 +1,130 @@ + + + + + tpsession: tpsession.h Source File + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + + +

tpsession.h

00001 /*
+00002  * This file is part of TpSession
+00003  *
+00004  * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+00005  * Contact Kate Alhola  kate.alholanokia.com
+00006  *
+00007  * This library is free software; you can redistribute it and/or
+00008  * modify it under the terms of the GNU Lesser General Public
+00009  * License as published by the Free Software Foundation; either
+00010  * version 2.1 of the License, or (at your option) any later version.
+00011  *
+00012  * This library is distributed in the hope that it will be useful,
+00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
+00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00015  * Lesser General Public License for more details.
+00016  *
+00017  * You should have received a copy of the GNU Lesser General Public
+00018  * License along with this library; if not, write to the Free Software
+00019  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+00020  */
+00021 #ifndef TPSESSION_H
+00022 #define TPSESSION_H
+00023 
+00024 #include <TelepathyQt4/Types>
+00025 #include <TelepathyQt4/Account>
+00026 #include <TelepathyQt4/Types>
+00027 #include <TelepathyQt4/PendingChannelRequest>
+00028 #include <TelepathyQt4/ChannelRequest>
+00029 #include <TelepathyQt4/PendingChannel>
+00030 #include <TelepathyQt4/Channel>
+00031 #include <TelepathyQt4/TextChannel>
+00032 #include <TelepathyQt4/AccountManager>
+00033 #include <TelepathyQt4/PendingOperation>
+00034 #include <TelepathyQt4/PendingReady>
+00035 #include <TelepathyQt4/ClientRegistrar>
+00036 #include <TelepathyQt4/Debug>
+00037 
+00038 #include <QString>
+00039 #include <QVector>
+00040 #include <QObject>
+00041 
+00042 #include "tpsessionaccount.h"
+00043 #include "tpsessionobserver.h"
+00044 
+00045 class TpSession:public QObject
+00046 {
+00047        Q_OBJECT
+00048 public:
+00049     TpSession(QString cmname=QString(),bool synchronous=FALSE);
+00050 
+00051 
+00052     static TpSession* instance(bool synchronous=TRUE);
+00053     void sendMessageToAddress(QString connectionMgr,QString address,QString message);
+00054     TpSessionAccount* getAccount(const  QString cm, const QString protocol=QString());
+00055     void createChannelListener(const QString &channelType,
+00056                                const Tp::MethodInvocationContextPtr<> &context,
+00057                                const Tp::AccountPtr &account,
+00058                                const Tp::ChannelPtr &channel);
+00059     void createObserver();
+00060 
+00061 signals:
+00062     void amReady(TpSession *);
+00063     void accountReady(TpSessionAccount *);
+00064     void channeReady(TpSessionAccount *);
+00065     void messageReceived(const Tp::ReceivedMessage &,TpSessionAccount *);
+00066 private slots:
+00067     void onAMReady(Tp::PendingOperation *);
+00068     void onAccountCreated(const QString &);
+00069     void onReady(Tp::PendingOperation *);
+00070     void onAccountReady(TpSessionAccount *tpacc);
+00071     void onMessageReceived(const Tp::ReceivedMessage &,TpSessionAccount *);
+00072 public:
+00073     QVector<TpSessionAccount*> accounts;
+00074 
+00075 private:
+00076     static TpSession *instancePtr;
+00077     //TpSession *instancePtr;
+00078     QString reqCm;
+00079     QString reqAddress;
+00080     QString reqMsg;
+00081 
+00082     bool sync;  // Synchronous initialization
+00083     QEventLoop loop;
+00084     Tp::AccountManagerPtr mAM;
+00085     QStringList channels;
+00086     Tp::ClientRegistrarPtr registrar;
+00087 };
+00088 
+00089 
+00090 
+00091 #endif // TPSESSION_H
+
+

+ + + +
Copyright © 2010 Nokia Corporation
TpSession
+ + diff --git a/www/doxygen/tpsessionaccount_8h-source.html b/www/doxygen/tpsessionaccount_8h-source.html new file mode 100644 index 0000000..e2ea1d2 --- /dev/null +++ b/www/doxygen/tpsessionaccount_8h-source.html @@ -0,0 +1,119 @@ + + + + + tpsession: tpsessionaccount.h Source File + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + + +

tpsessionaccount.h

00001 /*
+00002  * This file is part of TpSession
+00003  *
+00004  * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+00005  * Contact Kate Alhola  kate.alholanokia.com
+00006  *
+00007  * This library is free software; you can redistribute it and/or
+00008  * modify it under the terms of the GNU Lesser General Public
+00009  * License as published by the Free Software Foundation; either
+00010  * version 2.1 of the License, or (at your option) any later version.
+00011  *
+00012  * This library is distributed in the hope that it will be useful,
+00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
+00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00015  * Lesser General Public License for more details.
+00016  *
+00017  * You should have received a copy of the GNU Lesser General Public
+00018  * License along with this library; if not, write to the Free Software
+00019  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+00020  */
+00021 #ifndef TPSESSIONACCOUNT_H
+00022 #define TPSESSIONACCOUNT_H
+00023 
+00024 #include <TelepathyQt4/Types>
+00025 #include <TelepathyQt4/Account>
+00026 #include <TelepathyQt4/Types>
+00027 #include <TelepathyQt4/PendingChannelRequest>
+00028 #include <TelepathyQt4/ChannelRequest>
+00029 #include <TelepathyQt4/PendingChannel>
+00030 #include <TelepathyQt4/PendingContacts>
+00031 #include <TelepathyQt4/Channel>
+00032 #include <TelepathyQt4/TextChannel>
+00033 #include <TelepathyQt4/AccountManager>
+00034 #include <TelepathyQt4/PendingReady>
+00035 #include <TelepathyQt4/ContactManager>
+00036 
+00037 #include <QString>
+00038 #include <QVector>
+00039 
+00040 #include "tpsessionchannel.h"
+00041 
+00042 class TpSessionAccount:public QObject
+00043 {
+00044 
+00045     Q_OBJECT
+00046 public:
+00047   TpSessionAccount(Tp::AccountManagerPtr am,const QString &objectPath);
+00048   void makeContactFromAddress(QString address);
+00049   void sendMessageToAddress(QString address,QString message);
+00050   Tp::ContactPtr getContactFromAddress(QString address);
+00051   void addOutgoingChannel(const Tp::ContactPtr &contact);
+00052   void addOutgoingChannel(QString address);
+00053   TpSessionChannel *getChannelFromPeerAddress(QString id);
+00054 signals:
+00055   void accountReady(TpSessionAccount *);
+00056   void channelReady(TpSessionAccount *);
+00057   void messageReceived(const Tp::ReceivedMessage &,TpSessionAccount *);
+00058   void messageSent(const Tp::Message &,TpSessionAccount *);
+00059   void newChannel(TpSessionAccount *,QString,QString,const Tp::ChannelDetails &);
+00060 
+00061 private slots:
+00062   void onReady(Tp::PendingOperation *op);
+00063   void onOutgoingChannelReady(TpSessionChannel *ch);
+00064   void onContactsConnectionReady(Tp::PendingOperation *op);
+00065   void onNewContactRetrieved(Tp::PendingOperation *op);
+00066   void onMessageReceived(const Tp::ReceivedMessage &,TpSessionChannel *);
+00067   void onMessageSent(const Tp::Message &,Tp::MessageSendingFlags, const QString &);
+00068   void onNewChannels(const Tp::ChannelDetailsList&);
+00069 public:
+00070   bool ready;
+00071   QString reqContact;
+00072   QString reqMessage;
+00073   Tp::AccountPtr mAcc;
+00074   Tp::Account *acc;
+00075   Tp::ConnectionPtr contactsConn;
+00076   QSet<Tp::ContactPtr> myContacts;
+00077   QSet<TpSessionChannel *> myChannels;
+00078 };
+00079 
+00080 #endif // TPSESSIONACCOUNT_H
+
+

+ + + +
Copyright © 2010 Nokia Corporation
TpSession
+ + diff --git a/www/doxygen/tpsessionchannel_8h-source.html b/www/doxygen/tpsessionchannel_8h-source.html new file mode 100644 index 0000000..25656ee --- /dev/null +++ b/www/doxygen/tpsessionchannel_8h-source.html @@ -0,0 +1,99 @@ + + + + + tpsession: tpsessionchannel.h Source File + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + + +

tpsessionchannel.h

00001 /*
+00002  * This file is part of TpSession
+00003  *
+00004  * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+00005  * Contact Kate Alhola  kate.alholanokia.com
+00006  *
+00007  * This library is free software; you can redistribute it and/or
+00008  * modify it under the terms of the GNU Lesser General Public
+00009  * License as published by the Free Software Foundation; either
+00010  * version 2.1 of the License, or (at your option) any later version.
+00011  *
+00012  * This library is distributed in the hope that it will be useful,
+00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
+00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00015  * Lesser General Public License for more details.
+00016  *
+00017  * You should have received a copy of the GNU Lesser General Public
+00018  * License along with this library; if not, write to the Free Software
+00019  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+00020  */
+00021 #ifndef TPSESSIONCHANNEL_H
+00022 #define TPSESSIONCHANNEL_H
+00023 
+00024 #include <QObject>
+00025 #include <TelepathyQt4/Types>
+00026 #include <TelepathyQt4/Types>
+00027 #include <TelepathyQt4/Message>
+00028 #include <TelepathyQt4/PendingChannel>
+00029 #include <TelepathyQt4/ChannelRequest>
+00030 #include <TelepathyQt4/Channel>
+00031 #include <TelepathyQt4/TextChannel>
+00032 #include <TelepathyQt4/PendingReady>
+00033 #include <TelepathyQt4/ContactManager>
+00034 #include <TelepathyQt4/Connection>
+00035 
+00036 class TpSessionChannel : public QObject
+00037 {
+00038   Q_OBJECT
+00039 public:
+00040     TpSessionChannel(Tp::TextChannelPtr);
+00041     TpSessionChannel(Tp::ConnectionPtr conn,const Tp::ContactPtr &contact);
+00042     void sendMessage(QString message);
+00043     QString peerId();
+00044 signals:
+00045   void channelReady(TpSessionChannel *);
+00046   void channelDestroyed(TpSessionChannel *);
+00047   void messageReceived(const Tp::ReceivedMessage &,TpSessionChannel *);
+00048   void messageSent(const Tp::Message &,Tp::MessageSendingFlags, const QString &,TpSessionChannel *);
+00049 public slots:
+00050     void onChannelCreated(Tp::PendingOperation *op);
+00051     void onChannelReady(Tp::PendingOperation *op);
+00052     void onChannelDestroyed(QObject *);
+00053     void onMessageReceived(const Tp::ReceivedMessage &);
+00054     void onMessageSent(const Tp::Message &,Tp::MessageSendingFlags, const QString &);
+00055 public:
+00056     Tp::ContactPtr peerContact;
+00057     Tp::TextChannelPtr channel;
+00058 };
+00059 
+00060 #endif // TPSESSIONCHANNEL_H
+
+

+ + + +
Copyright © 2010 Nokia Corporation
TpSession
+ + diff --git a/www/doxygen/tpsessionobserver_8h-source.html b/www/doxygen/tpsessionobserver_8h-source.html new file mode 100644 index 0000000..bf85ad3 --- /dev/null +++ b/www/doxygen/tpsessionobserver_8h-source.html @@ -0,0 +1,67 @@ + + + + + tpsession: tpsessionobserver.h Source File + + + + + + + + +
   + +Home · + +All Classes · + +All Namespaces · + +Modules · + +Functions · + +Files +
+ + + +

tpsessionobserver.h

00001 #ifndef TPSESSIONOBSERVER_H
+00002 #define TPSESSIONOBSERVER_H
+00003 
+00004 #include <QObject>
+00005 #include <TelepathyQt4/AbstractClientObserver>
+00006 #include <TelepathyQt4/Types>
+00007 #include <TelepathyQt4/Channel>
+00008 
+00009 class TpSession;
+00010 
+00011 class TpSessionObserver : public QObject , public Tp::AbstractClientObserver
+00012 {
+00013        Q_OBJECT
+00014 public:
+00015     TpSessionObserver(const Tp::ChannelClassList &channelfilter,TpSession *session);
+00016     TpSession *tpSession;
+00017 
+00018 
+00022     virtual void observeChannels(const Tp::MethodInvocationContextPtr<> &context,
+00023             const Tp::AccountPtr &account,
+00024             const Tp::ConnectionPtr &connection,
+00025             const QList<Tp::ChannelPtr> &channels,
+00026             const Tp::ChannelDispatchOperationPtr &dispatchOperation,
+00027             const QList<Tp::ChannelRequestPtr> &requestsSatisfied,
+00028             const QVariantMap &observerInfo);
+00029 };
+00030 
+00031 #endif // TPSESSIONOBSERVER_H
+
+

+ + + +
Copyright © 2010 Nokia Corporation
TpSession
+ + diff --git a/www/images/borders.png b/www/images/borders.png new file mode 100644 index 0000000..81f990e Binary files /dev/null and b/www/images/borders.png differ diff --git a/www/images/bottom.png b/www/images/bottom.png new file mode 100644 index 0000000..721ba40 Binary files /dev/null and b/www/images/bottom.png differ diff --git a/www/images/top.png b/www/images/top.png new file mode 100644 index 0000000..7757e06 Binary files /dev/null and b/www/images/top.png differ diff --git a/www/index.html b/www/index.html index 1bbd1b1..38c3582 100644 --- a/www/index.html +++ b/www/index.html @@ -1,7 +1,67 @@ -

TpSession

+ + -Tpsession, Easy to use API library for Telepathy -

-More documentation goes here soon. -

- TpSession garage page + + + TpSession + + + +

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

Overview

+ TpSession library provides simplified layer top of Telepathy with easy to use API. TpSession is not abstraction layer that tries to hide Telepathy-Qt4 API, it just provides simple methods to perform most common use cases. At the moment, TpSession is early proof of concept and it is missing lot of features. Current version only supports textual SMS and IM with any of Telepathy connection Managers. When TpSession is not abstratction layer, it is not cross platform for non telepathy environments. Qt Mobility will be cross platform abstraction layer and TpSession is used as adaptation layer for Fremantle Qt Mobility.
+ +
+
+

FAQ

+ When I should use Qt Mobility and When TpSession library ?
+ By default, you should use QtMobility always when it provides functions you need.QtMobility is cross platform, TpSession works only in Maemo or it may work other plaforms using Telepathy Framework. If you need some functionality not provided by QtMobility, you can use TpSession. With Maemo Fremantle QtMobility you can access TpSession features with TpSession::getinstance() +
+ + How can I install a TpSession to device or SDK?
+ libtpsession is available from maemo fremantle extras-devel repository +
+
+ + + + +
+ + + diff --git a/www/style.css b/www/style.css new file mode 100644 index 0000000..b53f30d --- /dev/null +++ b/www/style.css @@ -0,0 +1,198 @@ +body { + background: white; + font-family: Verdana, sans-serif; + font-size: 13px; + color: black; + margin: 0px; +} + +div, img { + margin: 0; + padding: 0; + border: none; +} + +#wrap { + margin-left: auto; + margin-right: auto; + width: 800px; + background: url('images/borders.png') repeat-y; +} + +#intro { + align: center; +} + +#header { + height: 131px; + background: url('images/top.png') no-repeat; + +} +#header h1 { + valign:center; + margin-top:140px; + padding-top:40px; + font-weight: bold; + font-size: 30pt; + text-align: center; +} + + +#counter { + text-align: right; + margin: 0 10px 0 11px; +} +#nav { + background: #E5E4E5; + text-align: center; + vertical-align: middle; + margin: 0 10px 0 11px; + height: 2em; +} + +#nav a { + color: black; + line-height: 2em; +vv padding: 0 5px 0 5px; + text-decoration: none; +} + +#nav a:hover, #nav a.selected { + color: black; + background: #AFDC3B; +} + +#version{ + text-align: right; + font-size: x-small; + margin: 0 10px 0 11px; + background: #C5E76F; + +} + +#version a:hover, #nav a.selected { + color: #FF9600; + background: #AFDC3B; +} + +#version a { + color: #FF9600; +} + +#news { + margin:20px; + font-weight: bold; + text-align: center; + background: #AFDC3B; +} + +#news-content{ + font-weight: normal; + margin: 2px; + text-align: left; + background: #c5e76f; +} +#content { + padding: 0 5% 0 4%; + line-height: 1.6; + font-family: Verdana, Arial, Helvetica, sans-serif; + margin:20px; +} + +#content h3 { + margin-left: -5px; +} + + +#content p:first-letter { + margin-left: 1em; +} + +#content a { + text-decoration: none; + color: #fa9f0f; +} + +#content a:hover { + text-decoration: underline; +} + +#content a.top { + font-size: x-small; + float: right; +} + +#content img { + vertical-align:top; +} + +#footer { + background: url('images/bottom.png') no-repeat; + height: 127px; + text-align: center; + font-size: xx-small; + padding: 0px 24px 0 25px; +} + +#footer a { + text-decoration: underline; +} + +#footer a:hover { + color: white; +} + +#footer p { + padding-top: 20px; +} + +h2 { + font-weight: normal; + border-bottom: 1px solid #E5E4E5; +} + +pre { + margin: 0 1em 0 1em; + padding: 5px; + background: #EFEFEF; + border: 1px #CCCCCC; + border-style: solid none solid; +} + +dl { + margin-left: 1em; + margin-top: 0.2em; + margin-bottom: 0.5em; +} + +dt { + font-weight: bold; + margin-bottom: 0.1em; +} + +dd { + line-height: 1.5em; + margin-left: 2em; + margin-bottom: 0.1em; +} + +abbr, acronym { + border-bottom: 1px dotted black; + cursor: help; + letter-spacing: normal; +} + +table { + font-size: 100%; + margin: 0em; +} + +.category { margin: 0px; padding: 0px; font-size: 14pt; } +.devpanel { } +.userpanel { border-left: solid 1px #e5e4e5; } +.artpanel { border-left: solid 1px #e5e4e5; } +.formDataHeader { text-align: right; border-right: 1px solid #DADDE0; } +.mandatoryFormDataHeader { text-align: right; border-right: 1px solid #DADDE0; color: red; } +.box { font-size: 9pt; background-color: #FFFFFF; border: solid 1px #DADDE0; } +.openBox { background-color: #FFFFFF; border: solid 1px black; border-top: none; } +.explanatoryText { font-size: x-small; color: #777777; } diff --git a/www/style.css~ b/www/style.css~ new file mode 100644 index 0000000..52c4cba --- /dev/null +++ b/www/style.css~ @@ -0,0 +1,193 @@ +body { + background: white; + font-family: Verdana, sans-serif; + font-size: 13px; + color: black; + margin: 0px; +} + +div, img { + margin: 0; + padding: 0; + border: none; +} + +#wrap { + margin-left: auto; + margin-right: auto; + width: 800px; + background: url('images/borders.png') repeat-y; +} + +#intro { + align: center; +} + +#header { + height: 131px; + background: url('images/top.png') no-repeat; + +} + +#header h1 { + display: none; +} + +#counter { + text-align: right; + margin: 0 10px 0 11px; +} +#nav { + background: #E5E4E5; + text-align: center; + vertical-align: middle; + margin: 0 10px 0 11px; + height: 2em; +} + +#nav a { + color: black; + line-height: 2em; + padding: 0 5px 0 5px; + text-decoration: none; +} + +#nav a:hover, #nav a.selected { + color: black; + background: #AFDC3B; +} + +#version{ + text-align: right; + font-size: x-small; + margin: 0 10px 0 11px; + background: #C5E76F; + +} + +#version a:hover, #nav a.selected { + color: #FF9600; + background: #AFDC3B; +} + +#version a { + color: #FF9600; +} + +#news { + margin:20px; + font-weight: bold; + text-align: center; + background: #AFDC3B; +} + +#news-content{ + font-weight: normal; + margin: 2px; + text-align: left; + background: #c5e76f; +} +#content { + padding: 0 5% 0 4%; + line-height: 1.6; + font-family: Verdana, Arial, Helvetica, sans-serif; + margin:20px; +} + +#content h3 { + margin-left: -5px; +} + + +#content p:first-letter { + margin-left: 1em; +} + +#content a { + text-decoration: none; + color: #fa9f0f; +} + +#content a:hover { + text-decoration: underline; +} + +#content a.top { + font-size: x-small; + float: right; +} + +#content img { + vertical-align:top; +} + +#footer { + background: url('images/bottom.png') no-repeat; + height: 127px; + text-align: center; + font-size: xx-small; + padding: 0px 24px 0 25px; +} + +#footer a { + text-decoration: underline; +} + +#footer a:hover { + color: white; +} + +#footer p { + padding-top: 20px; +} + +h2 { + font-weight: normal; + border-bottom: 1px solid #E5E4E5; +} + +pre { + margin: 0 1em 0 1em; + padding: 5px; + background: #EFEFEF; + border: 1px #CCCCCC; + border-style: solid none solid; +} + +dl { + margin-left: 1em; + margin-top: 0.2em; + margin-bottom: 0.5em; +} + +dt { + font-weight: bold; + margin-bottom: 0.1em; +} + +dd { + line-height: 1.5em; + margin-left: 2em; + margin-bottom: 0.1em; +} + +abbr, acronym { + border-bottom: 1px dotted black; + cursor: help; + letter-spacing: normal; +} + +table { + font-size: 100%; + margin: 0em; +} + +.category { margin: 0px; padding: 0px; font-size: 14pt; } +.devpanel { } +.userpanel { border-left: solid 1px #e5e4e5; } +.artpanel { border-left: solid 1px #e5e4e5; } +.formDataHeader { text-align: right; border-right: 1px solid #DADDE0; } +.mandatoryFormDataHeader { text-align: right; border-right: 1px solid #DADDE0; color: red; } +.box { font-size: 9pt; background-color: #FFFFFF; border: solid 1px #DADDE0; } +.openBox { background-color: #FFFFFF; border: solid 1px black; border-top: none; } +.explanatoryText { font-size: x-small; color: #777777; }