[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    koffice/lib/kofficeui
From:       Casper Boemann <cbr () boemann ! dk>
Date:       2005-12-16 10:44:59
Message-ID: 1134729899.293337.8737.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 488899 by boemann:

expand on api doc


 M  +5 -1      koGuides.h  


--- trunk/koffice/lib/kofficeui/koGuides.h #488898:488899
@@ -147,10 +147,14 @@
      * @brief Snap rect to guidelines
      *
      * This looks for a guide which is in reach for the guide as defined \
in snap. +     * This method has the abillity to combine more calls. The \
snapStatus and diff args are both input and +     * output. On first call \
you should set snapStatus to 0. The return value would then show in which + \
* directions it has snapped. If you combine several KoGuides you can let \
these output arguments +     * be input for the next koGuide. That way \
                you'll always catch the nearest guide.
      *
      * @param rect the rect which should be snapped
      * @param snap the distance within the guide should snap - but always \
                snap if already snapped
-     * @param snapStatus if horiz,vert or both directions are snapped \
(both in and out param) +     * @param snapStatus if horiz,vert or both \
                directions are snapped (both in and out param). 
      * @param diff distance away from guide. Only valid if status is \
                snapping (both in and out param)
      */
     void snapToGuideLines( KoRect &rect, int snap, SnapStatus &snapStatus, \
KoPoint &diff );


[prev in list] [next in list] [prev in thread] [next in thread]