diff options
author | Jorg Schuler <jcsjcs@users.sourceforge.net> | 2007-04-27 16:04:44 +0000 |
---|---|---|
committer | Jorg Schuler <jcsjcs@users.sourceforge.net> | 2007-04-27 16:04:44 +0000 |
commit | a9ea47818b18b3fe5e4439dca7e0f332ea8187b3 (patch) | |
tree | 151d5f4f4fccfd9b0fd6952dc2fc59278d6326c2 /docs | |
parent | b34501302adc66f968ba6b50e21c90527296026e (diff) | |
download | libgpod-a9ea47818b18b3fe5e4439dca7e0f332ea8187b3.tar.gz libgpod-a9ea47818b18b3fe5e4439dca7e0f332ea8187b3.tar.xz libgpod-a9ea47818b18b3fe5e4439dca7e0f332ea8187b3.zip |
Namespace cleanup part II (python bindings and documentation).
structs:
SPLPref -> Itdb_SPLPref
SPLRules -> Itdb_SPLRules
SPLRule -> Itdb_SPLRule
SPL_* -> ITDB_SPL_*
enums, #defines:
LIMITTYPE_* -> ITDB_LIMITTYPE_*
LIMITSORT_* -> ITDB_LIMITSORT_*
SPLMATCH_* -> ITDB_SPLMATCH_*
SPLACTION_* -> ITDB_SPLACTION_*
SPLFIELD_* -> ITDB_SPLFIELD_*
SPLDATE_IDENTIFIER -> ITDB_SPL_DATE_IDENTIFIER
splft_* -> ITDB_SPLFT_*
splat_* -> ITDB_SPLAT_*
enum SPLAction -> ItdbSPLAction
enum SPLActionType -> ItdbSPLActionType
enum SPLField -> ItdbSPLField
enum SPLFieldType -> ItdbSPLFieldType
enum ItdbLimitType (new)
enum ItdbLimitSort (new)
enum ItdbSPLMatch (new)
removed SPL_MAXSTRINGLENGTH (use ITDB_SPL_STRING_MAXLEN)
git-svn-id: https://gtkpod.svn.sf.net/svnroot/gtkpod/libgpod/trunk@1419 f01d2545-417e-4e96-918e-98f8d0dbbcb6
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/libgpod-sections.txt | 48 | ||||
-rw-r--r-- | docs/reference/tmpl/libgpod-unused.sgml | 226 | ||||
-rw-r--r-- | docs/reference/tmpl/smart-playlists.sgml | 191 |
3 files changed, 332 insertions, 133 deletions
diff --git a/docs/reference/libgpod-sections.txt b/docs/reference/libgpod-sections.txt index 6877ff5..62e2d40 100644 --- a/docs/reference/libgpod-sections.txt +++ b/docs/reference/libgpod-sections.txt @@ -120,16 +120,20 @@ itdb_playlist_randomize <SECTION> <FILE>smart-playlists</FILE> <TITLE>Smart Playlists</TITLE> -SPLPref -SPLRule -SPLRules -SPLAction -SPLFieldType -SPLActionType -SPLField -SPLDATE_IDENTIFIER +Itdb_SPLPref +Itdb_SPLRule +Itdb_SPLRules +ItdbLimitSort +ItdbLimitType +ItdbSPLAction +ItdbSPLActionLast +ItdbSPLActionType +ItdbSPLField +ItdbSPLFieldType +ItdbSPLMatch +ITDB_SPLDATE_IDENTIFIER SPL_MAXSTRINGLENGTH -SPL_STRING_MAXLEN +ITDB_SPL_STRING_MAXLEN itdb_splr_get_field_type itdb_splr_get_action_type itdb_splr_validate @@ -285,19 +289,19 @@ itdb_get_artwork_info_from_type DbType Itdb_DB -SPLACTION_LAST_HOURS_VALUE -SPLACTION_LAST_MINUTES_VALUE -SPLACTION_LAST_YEARS_VALUE -SPLACTION_LAST_LUNARCYCLE_VALUE -SPLACTION_LAST_SIDEREAL_DAY -SPLACTION_LAST_SWATCH_BEAT -SPLACTION_LAST_MOMENT -SPLACTION_LAST_OSTENT -SPLACTION_LAST_FORTNIGHT -SPLACTION_LAST_VINAL -SPLACTION_LAST_QUARTER -SPLACTION_LAST_SOLAR_YEAR -SPLACTION_LAST_SIDEREAL_YEAR +ITDB_SPLACTION_LAST_HOURS_VALUE +ITDB_SPLACTION_LAST_MINUTES_VALUE +ITDB_SPLACTION_LAST_YEARS_VALUE +ITDB_SPLACTION_LAST_LUNARCYCLE_VALUE +ITDB_SPLACTION_LAST_SIDEREAL_DAY +ITDB_SPLACTION_LAST_SWATCH_BEAT +ITDB_SPLACTION_LAST_MOMENT +ITDB_SPLACTION_LAST_OSTENT +ITDB_SPLACTION_LAST_FORTNIGHT +ITDB_SPLACTION_LAST_VINAL +ITDB_SPLACTION_LAST_QUARTER +ITDB_SPLACTION_LAST_SOLAR_YEAR +ITDB_SPLACTION_LAST_SIDEREAL_YEAR </SECTION> diff --git a/docs/reference/tmpl/libgpod-unused.sgml b/docs/reference/tmpl/libgpod-unused.sgml index ebb16c4..9749355 100644 --- a/docs/reference/tmpl/libgpod-unused.sgml +++ b/docs/reference/tmpl/libgpod-unused.sgml @@ -28,6 +28,96 @@ iTunesDB </para> +<!-- ##### MACRO ITDB_SPLACTION_LAST_FORTNIGHT ##### --> +<para> + +</para> + + +<!-- ##### MACRO ITDB_SPLACTION_LAST_HOURS_VALUE ##### --> +<para> + +</para> + + +<!-- ##### MACRO ITDB_SPLACTION_LAST_LUNARCYCLE_VALUE ##### --> +<para> + +</para> + + +<!-- ##### MACRO ITDB_SPLACTION_LAST_MINUTES_VALUE ##### --> +<para> + +</para> + + +<!-- ##### MACRO ITDB_SPLACTION_LAST_MOMENT ##### --> +<para> + +</para> + + +<!-- ##### MACRO ITDB_SPLACTION_LAST_OSTENT ##### --> +<para> + +</para> + + +<!-- ##### MACRO ITDB_SPLACTION_LAST_QUARTER ##### --> +<para> + +</para> + + +<!-- ##### MACRO ITDB_SPLACTION_LAST_SIDEREAL_DAY ##### --> +<para> + +</para> + + +<!-- ##### MACRO ITDB_SPLACTION_LAST_SIDEREAL_YEAR ##### --> +<para> + +</para> + + +<!-- ##### MACRO ITDB_SPLACTION_LAST_SOLAR_YEAR ##### --> +<para> + +</para> + + +<!-- ##### MACRO ITDB_SPLACTION_LAST_SWATCH_BEAT ##### --> +<para> + +</para> + + +<!-- ##### MACRO ITDB_SPLACTION_LAST_VINAL ##### --> +<para> + +</para> + + +<!-- ##### MACRO ITDB_SPLACTION_LAST_YEARS_VALUE ##### --> +<para> + +</para> + + +<!-- ##### MACRO ITDB_SPLDATE_IDENTIFIER ##### --> +<para> + +</para> + + +<!-- ##### MACRO ITDB_SPL_MAXSTRINGLENGTH ##### --> +<para> + +</para> + + <!-- ##### ENUM ItdbFileError ##### --> <para> @@ -75,79 +165,151 @@ iTunesDB @MODEL_TYPE_VIDEO_BLACK: @MODEL_TYPE_MOBILE_1: -<!-- ##### MACRO SPLACTION_LAST_FORTNIGHT ##### --> -<para> - -</para> - - -<!-- ##### MACRO SPLACTION_LAST_HOURS_VALUE ##### --> +<!-- ##### ENUM SPLAction ##### --> <para> </para> - -<!-- ##### MACRO SPLACTION_LAST_LUNARCYCLE_VALUE ##### --> +@SPLACTION_IS_INT: +@SPLACTION_IS_GREATER_THAN: +@SPLACTION_IS_LESS_THAN: +@SPLACTION_IS_IN_THE_RANGE: +@SPLACTION_IS_IN_THE_LAST: +@SPLACTION_BINARY_AND: +@SPLACTION_IS_STRING: +@SPLACTION_CONTAINS: +@SPLACTION_STARTS_WITH: +@SPLACTION_ENDS_WITH: +@SPLACTION_IS_NOT_INT: +@SPLACTION_IS_NOT_GREATER_THAN: +@SPLACTION_IS_NOT_LESS_THAN: +@SPLACTION_IS_NOT_IN_THE_RANGE: +@SPLACTION_IS_NOT_IN_THE_LAST: +@SPLACTION_IS_NOT: +@SPLACTION_DOES_NOT_CONTAIN: +@SPLACTION_DOES_NOT_START_WITH: +@SPLACTION_DOES_NOT_END_WITH: + +<!-- ##### ENUM SPLActionType ##### --> <para> </para> - -<!-- ##### MACRO SPLACTION_LAST_MINUTES_VALUE ##### --> +@splat_string: +@splat_int: +@splat_date: +@splat_range_int: +@splat_range_date: +@splat_inthelast: +@splat_playlist: +@splat_none: +@splat_invalid: +@splat_unknown: +@splat_binary_and: + +<!-- ##### MACRO SPLDATE_IDENTIFIER ##### --> <para> </para> -<!-- ##### MACRO SPLACTION_LAST_MOMENT ##### --> +<!-- ##### ENUM SPLField ##### --> <para> </para> - -<!-- ##### MACRO SPLACTION_LAST_OSTENT ##### --> +@SPLFIELD_SONG_NAME: +@SPLFIELD_ALBUM: +@SPLFIELD_ARTIST: +@SPLFIELD_BITRATE: +@SPLFIELD_SAMPLE_RATE: +@SPLFIELD_YEAR: +@SPLFIELD_GENRE: +@SPLFIELD_KIND: +@SPLFIELD_DATE_MODIFIED: +@SPLFIELD_TRACKNUMBER: +@SPLFIELD_SIZE: +@SPLFIELD_TIME: +@SPLFIELD_COMMENT: +@SPLFIELD_DATE_ADDED: +@SPLFIELD_COMPOSER: +@SPLFIELD_PLAYCOUNT: +@SPLFIELD_LAST_PLAYED: +@SPLFIELD_DISC_NUMBER: +@SPLFIELD_RATING: +@SPLFIELD_COMPILATION: +@SPLFIELD_BPM: +@SPLFIELD_GROUPING: +@SPLFIELD_PLAYLIST: +@SPLFIELD_VIDEO_KIND: +@SPLFIELD_TVSHOW: +@SPLFIELD_SEASON_NR: +@SPLFIELD_SKIPCOUNT: +@SPLFIELD_LAST_SKIPPED: +@SPLFIELD_ALBUMARTIST: + +<!-- ##### ENUM SPLFieldType ##### --> <para> </para> +@splft_string: +@splft_int: +@splft_boolean: +@splft_date: +@splft_playlist: +@splft_unknown: +@splft_binary_and: -<!-- ##### MACRO SPLACTION_LAST_QUARTER ##### --> +<!-- ##### STRUCT SPLPref ##### --> <para> </para> +@liveupdate: +@checkrules: +@checklimits: +@limittype: +@limitsort: +@limitvalue: +@matchcheckedonly: -<!-- ##### MACRO SPLACTION_LAST_SIDEREAL_DAY ##### --> +<!-- ##### STRUCT SPLRule ##### --> <para> </para> - -<!-- ##### MACRO SPLACTION_LAST_SIDEREAL_YEAR ##### --> -<para> - -</para> - - -<!-- ##### MACRO SPLACTION_LAST_SOLAR_YEAR ##### --> -<para> - -</para> - - -<!-- ##### MACRO SPLACTION_LAST_SWATCH_BEAT ##### --> +@field: +@action: +@string: +@fromvalue: +@fromdate: +@fromunits: +@tovalue: +@todate: +@tounits: +@unk052: +@unk056: +@unk060: +@unk064: +@unk068: + +<!-- ##### STRUCT SPLRules ##### --> <para> </para> +@unk004: +@match_operator: +@rules: -<!-- ##### MACRO SPLACTION_LAST_VINAL ##### --> +<!-- ##### MACRO SPL_MAXSTRINGLENGTH ##### --> <para> </para> -<!-- ##### MACRO SPLACTION_LAST_YEARS_VALUE ##### --> +<!-- ##### MACRO SPL_STRING_MAXLEN ##### --> <para> </para> diff --git a/docs/reference/tmpl/smart-playlists.sgml b/docs/reference/tmpl/smart-playlists.sgml index df8e641..b370276 100644 --- a/docs/reference/tmpl/smart-playlists.sgml +++ b/docs/reference/tmpl/smart-playlists.sgml @@ -17,7 +17,7 @@ These functions and structures are for dealing with smart playlists. <!-- ##### SECTION Stability_Level ##### --> -<!-- ##### STRUCT SPLPref ##### --> +<!-- ##### STRUCT Itdb_SPLPref ##### --> <para> </para> @@ -30,7 +30,7 @@ These functions and structures are for dealing with smart playlists. @limitvalue: @matchcheckedonly: -<!-- ##### STRUCT SPLRule ##### --> +<!-- ##### STRUCT Itdb_SPLRule ##### --> <para> </para> @@ -50,7 +50,7 @@ These functions and structures are for dealing with smart playlists. @unk064: @unk068: -<!-- ##### STRUCT SPLRules ##### --> +<!-- ##### STRUCT Itdb_SPLRules ##### --> <para> </para> @@ -59,111 +59,144 @@ These functions and structures are for dealing with smart playlists. @match_operator: @rules: -<!-- ##### ENUM SPLAction ##### --> +<!-- ##### ENUM ItdbLimitSort ##### --> <para> </para> -@SPLACTION_IS_INT: -@SPLACTION_IS_GREATER_THAN: -@SPLACTION_IS_LESS_THAN: -@SPLACTION_IS_IN_THE_RANGE: -@SPLACTION_IS_IN_THE_LAST: -@SPLACTION_BINARY_AND: -@SPLACTION_IS_STRING: -@SPLACTION_CONTAINS: -@SPLACTION_STARTS_WITH: -@SPLACTION_ENDS_WITH: -@SPLACTION_IS_NOT_INT: -@SPLACTION_IS_NOT_GREATER_THAN: -@SPLACTION_IS_NOT_LESS_THAN: -@SPLACTION_IS_NOT_IN_THE_RANGE: -@SPLACTION_IS_NOT_IN_THE_LAST: -@SPLACTION_IS_NOT: -@SPLACTION_DOES_NOT_CONTAIN: -@SPLACTION_DOES_NOT_START_WITH: -@SPLACTION_DOES_NOT_END_WITH: - -<!-- ##### ENUM SPLFieldType ##### --> +@ITDB_LIMITSORT_RANDOM: +@ITDB_LIMITSORT_SONG_NAME: +@ITDB_LIMITSORT_ALBUM: +@ITDB_LIMITSORT_ARTIST: +@ITDB_LIMITSORT_GENRE: +@ITDB_LIMITSORT_MOST_RECENTLY_ADDED: +@ITDB_LIMITSORT_LEAST_RECENTLY_ADDED: +@ITDB_LIMITSORT_MOST_OFTEN_PLAYED: +@ITDB_LIMITSORT_LEAST_OFTEN_PLAYED: +@ITDB_LIMITSORT_MOST_RECENTLY_PLAYED: +@ITDB_LIMITSORT_LEAST_RECENTLY_PLAYED: +@ITDB_LIMITSORT_HIGHEST_RATING: +@ITDB_LIMITSORT_LOWEST_RATING: + +<!-- ##### ENUM ItdbLimitType ##### --> <para> </para> -@splft_string: -@splft_int: -@splft_boolean: -@splft_date: -@splft_playlist: -@splft_unknown: -@splft_binary_and: +@ITDB_LIMITTYPE_MINUTES: +@ITDB_LIMITTYPE_MB: +@ITDB_LIMITTYPE_SONGS: +@ITDB_LIMITTYPE_HOURS: +@ITDB_LIMITTYPE_GB: -<!-- ##### ENUM SPLActionType ##### --> +<!-- ##### ENUM ItdbSPLAction ##### --> <para> </para> -@splat_string: -@splat_int: -@splat_date: -@splat_range_int: -@splat_range_date: -@splat_inthelast: -@splat_playlist: -@splat_none: -@splat_invalid: -@splat_unknown: -@splat_binary_and: - -<!-- ##### ENUM SPLField ##### --> +@ITDB_SPLACTION_IS_INT: +@ITDB_SPLACTION_IS_GREATER_THAN: +@ITDB_SPLACTION_IS_LESS_THAN: +@ITDB_SPLACTION_IS_IN_THE_RANGE: +@ITDB_SPLACTION_IS_IN_THE_LAST: +@ITDB_SPLACTION_BINARY_AND: +@ITDB_SPLACTION_IS_STRING: +@ITDB_SPLACTION_CONTAINS: +@ITDB_SPLACTION_STARTS_WITH: +@ITDB_SPLACTION_ENDS_WITH: +@ITDB_SPLACTION_IS_NOT_INT: +@ITDB_SPLACTION_IS_NOT_GREATER_THAN: +@ITDB_SPLACTION_IS_NOT_LESS_THAN: +@ITDB_SPLACTION_IS_NOT_IN_THE_RANGE: +@ITDB_SPLACTION_IS_NOT_IN_THE_LAST: +@ITDB_SPLACTION_IS_NOT: +@ITDB_SPLACTION_DOES_NOT_CONTAIN: +@ITDB_SPLACTION_DOES_NOT_START_WITH: +@ITDB_SPLACTION_DOES_NOT_END_WITH: + +<!-- ##### ENUM ItdbSPLActionLast ##### --> <para> </para> -@SPLFIELD_SONG_NAME: -@SPLFIELD_ALBUM: -@SPLFIELD_ARTIST: -@SPLFIELD_BITRATE: -@SPLFIELD_SAMPLE_RATE: -@SPLFIELD_YEAR: -@SPLFIELD_GENRE: -@SPLFIELD_KIND: -@SPLFIELD_DATE_MODIFIED: -@SPLFIELD_TRACKNUMBER: -@SPLFIELD_SIZE: -@SPLFIELD_TIME: -@SPLFIELD_COMMENT: -@SPLFIELD_DATE_ADDED: -@SPLFIELD_COMPOSER: -@SPLFIELD_PLAYCOUNT: -@SPLFIELD_LAST_PLAYED: -@SPLFIELD_DISC_NUMBER: -@SPLFIELD_RATING: -@SPLFIELD_COMPILATION: -@SPLFIELD_BPM: -@SPLFIELD_GROUPING: -@SPLFIELD_PLAYLIST: -@SPLFIELD_VIDEO_KIND: -@SPLFIELD_TVSHOW: -@SPLFIELD_SEASON_NR: -@SPLFIELD_SKIPCOUNT: -@SPLFIELD_LAST_SKIPPED: -@SPLFIELD_ALBUMARTIST: - -<!-- ##### MACRO SPLDATE_IDENTIFIER ##### --> +@ITDB_SPLACTION_LAST_DAYS_VALUE: +@ITDB_SPLACTION_LAST_WEEKS_VALUE: +@ITDB_SPLACTION_LAST_MONTHS_VALUE: + +<!-- ##### ENUM ItdbSPLActionType ##### --> <para> </para> +@ITDB_SPLAT_STRING: +@ITDB_SPLAT_INT: +@ITDB_SPLAT_DATE: +@ITDB_SPLAT_RANGE_INT: +@ITDB_SPLAT_RANGE_DATE: +@ITDB_SPLAT_INTHELAST: +@ITDB_SPLAT_PLAYLIST: +@ITDB_SPLAT_NONE: +@ITDB_SPLAT_INVALID: +@ITDB_SPLAT_UNKNOWN: +@ITDB_SPLAT_BINARY_AND: + +<!-- ##### ENUM ItdbSPLField ##### --> +<para> +</para> -<!-- ##### MACRO SPL_MAXSTRINGLENGTH ##### --> +@ITDB_SPLFIELD_SONG_NAME: +@ITDB_SPLFIELD_ALBUM: +@ITDB_SPLFIELD_ARTIST: +@ITDB_SPLFIELD_BITRATE: +@ITDB_SPLFIELD_SAMPLE_RATE: +@ITDB_SPLFIELD_YEAR: +@ITDB_SPLFIELD_GENRE: +@ITDB_SPLFIELD_KIND: +@ITDB_SPLFIELD_DATE_MODIFIED: +@ITDB_SPLFIELD_TRACKNUMBER: +@ITDB_SPLFIELD_SIZE: +@ITDB_SPLFIELD_TIME: +@ITDB_SPLFIELD_COMMENT: +@ITDB_SPLFIELD_DATE_ADDED: +@ITDB_SPLFIELD_COMPOSER: +@ITDB_SPLFIELD_PLAYCOUNT: +@ITDB_SPLFIELD_LAST_PLAYED: +@ITDB_SPLFIELD_DISC_NUMBER: +@ITDB_SPLFIELD_RATING: +@ITDB_SPLFIELD_COMPILATION: +@ITDB_SPLFIELD_BPM: +@ITDB_SPLFIELD_GROUPING: +@ITDB_SPLFIELD_PLAYLIST: +@ITDB_SPLFIELD_VIDEO_KIND: +@ITDB_SPLFIELD_TVSHOW: +@ITDB_SPLFIELD_SEASON_NR: +@ITDB_SPLFIELD_SKIPCOUNT: +@ITDB_SPLFIELD_LAST_SKIPPED: +@ITDB_SPLFIELD_ALBUMARTIST: + +<!-- ##### ENUM ItdbSPLFieldType ##### --> <para> </para> +@ITDB_SPLFT_STRING: +@ITDB_SPLFT_INT: +@ITDB_SPLFT_BOOLEAN: +@ITDB_SPLFT_DATE: +@ITDB_SPLFT_PLAYLIST: +@ITDB_SPLFT_UNKNOWN: +@ITDB_SPLFT_BINARY_AND: + +<!-- ##### ENUM ItdbSPLMatch ##### --> +<para> + +</para> +@ITDB_SPLMATCH_AND: +@ITDB_SPLMATCH_OR: -<!-- ##### MACRO SPL_STRING_MAXLEN ##### --> +<!-- ##### MACRO ITDB_SPL_STRING_MAXLEN ##### --> <para> </para> |