X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Ffcpattern.fncs;h=3b13c22d5cfee6c5b8a4741a581edaf6de88d9c4;hb=2ed73cdd0f0785ca235adf7800e6e43137117a4c;hp=928f0bcc6259c77aa86229cc05e45366aa9a2ec7;hpb=9f961062fee487fc411ccdd4f34f8fe52f3a5ee9;p=platform%2Fupstream%2Ffontconfig.git diff --git a/doc/fcpattern.fncs b/doc/fcpattern.fncs index 928f0bc..3b13c22 100644 --- a/doc/fcpattern.fncs +++ b/doc/fcpattern.fncs @@ -57,6 +57,15 @@ Decrement the pattern reference count. If all references are gone, destroys the pattern, in the process destroying all related values. @@ +@RET@ int +@FUNC@ FcPatternObjectCount +@TYPE1@ const FcPattern * @ARG1@ p +@PURPOSE@ Returns the number of the object +@DESC@ +Returns the number of the object p has. +@SINCE@ 2.13.1 +@@ + @RET@ FcBool @FUNC@ FcPatternEqual @TYPE1@ const FcPattern * @ARG1@ pa @@ -383,7 +392,107 @@ whether the property existed or not. Removes the value associated with the property `object' at position `id', returning whether the property existed and had a value at that position or not. @@ - + +@RET@ void +@FUNC@ FcPatternIterStart +@TYPE1@ const FcPattern * @ARG1@ p +@TYPE2@ FcPatternIter * @ARG2@ iter +@PURPOSE@ Initialize the iterator with the first iterator in the pattern +@DESC@ +Initialize iter with the first iterator in p. +If there are no objects in p, iter +will not have any valid data. +@SINCE@ 2.13.1 +@@ + +@RET@ FcBool +@FUNC@ FcPatternIterNext +@TYPE1@ const FcPattern * @ARG1@ p +@TYPE2@ FcPatternIter * @ARG2@ iter +@PURPUSE@ Set the iterator to point to the next object in the pattern +@DESC@ +Set iter to point to the next object in p +and returns FcTrue if iter has been changed to the next object. +returns FcFalse otherwise. +@SINCE@ 2.13.1 +@@ + +@RET@ FcBool +@FUNC@ FcPatternIterEqual +@TYPE1@ const FcPattern * @ARG1@ p1 +@TYPE2@ FcPatternIter * @ARG2@ i1 +@TYPE3@ const FcPattern * @ARG3@ p2 +@TYPE4@ FcPatternIter * @ARG4@ i2 +@PURPOSE@ Compare iterators +@DESC@ +Return FcTrue if both i1 and i2 +point to same object and contains same values. return FcFalse otherwise. +@SINCE@ 2.13.1 +@@ + +@RET@ FcBool +@FUNC@ FcPatternFindIter +@TYPE1@ const FcPattern * @ARG1@ p +@TYPE2@ FcPatternIter * @ARG2@ iter +@TYPE3@ const char * @ARG3@ object +@PURPOSE@ Set the iterator to point to the object in the pattern +@DESC@ +Set iter to point to object in +p if any and returns FcTrue. returns FcFalse otherwise. +@SINCE@ 2.13.1 +@@ + +@RET@ FcBool +@FUNC@ FcPatternIterIsValid +@TYPE1@ const FcPattern * @ARG1@ p +@TYPE2@ FcPatternIter : @ARG2@ iter +@PURPOSE@ Check whether the iterator is valid or not +@DESC@ +Returns FcTrue if iter point to the valid entry +in p. returns FcFalse otherwise. +@SINCE@ 2.13.1 +@@ + +@RET@ const char * +@FUNC@ FcPatternIterGetObject +@TYPE1@ const FcPattern * @ARG1@ p +@TYPE2@ FcPatternIter * @ARG2@ iter +@PURPOSE@ Returns an object name which the iterator point to +@DESC@ +Returns an object name in p which +iter point to. returns NULL if +iter isn't valid. +@SINCE@ 2.13.1 +@@ + +@RET@ int +@FUNC@ FcPatternIterValueCount +@TYPE1@ const FcPattern * @ARG1@ p +@TYPE2@ FcPatternIter * @ARG2@ iter +@PURPOSE@ Returns the number of the values which the iterator point to +@DESC@ +Returns the number of the values in the object which iter +point to. if iter isn't valid, returns 0. +@SINCE@ 2.13.1 +@@ + +@RET@ FcResult +@FUNC@ FcPatternIterGetValue +@TYPE1@ const FcPattern * @ARG1@ p +@TYPE2@ FcPatternIter * @ARG2@ iter +@TYPE3@ int @ARG3@ id +@TYPE4@ FcValue * @ARG4@ v +@TYPE5@ FcValueBinding * @ARG5@ b +@PURPOSE@ Returns a value which the iterator point to +@DESC@ +Returns in v the id'th value +which iter point to. also binding to b +if given. +The value returned is not a copy, but rather refers to the data stored +within the pattern directly. Applications must not free this value. +@SINCE@ 2.13.1 +@@ + @RET@ void @FUNC@ FcPatternPrint @TYPE1@ const FcPattern * @ARG1@ p