/[svn]/libgig/trunk/src/gig.h
ViewVC logotype

Diff of /libgig/trunk/src/gig.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 515 by schoenebeck, Sat May 7 20:19:10 2005 UTC revision 518 by schoenebeck, Sun May 8 16:19:34 2005 UTC
# Line 314  namespace gig { Line 314  namespace gig {
314       *       *
315       * The function pointer argument has to be supplied with a valid       * The function pointer argument has to be supplied with a valid
316       * function of the given signature which will then be called on       * function of the given signature which will then be called on
317       * progress changes. The float argument of the callback function will       * progress changes. An equivalent progress_t structure will be passed
318       * then reflect the current progress as a value between 0.0 and 1.0.       * back as argument to the callback function on each progress change.
319         * The factor field of the supplied progress_t structure will then
320         * reflect the current progress as value between 0.0 and 1.0. You might
321         * want to use the custom field for data needed in your callback
322         * function.
323       */       */
324      struct progress_t {      struct progress_t {
325          void (*callback)(float); ///< Callback function pointer which has to be assigned to a function for progress notification.          void (*callback)(progress_t*); ///< Callback function pointer which has to be assigned to a function for progress notification.
326          float __range_min;          float factor;                  ///< Reflects current progress as value between 0.0 and 1.0.
327          float __range_max;          void* custom;                  ///< This pointer can be used for arbitrary data.
328            float __range_min;             ///< Only for internal usage, do not modify!
329            float __range_max;             ///< Only for internal usage, do not modify!
330          progress_t();          progress_t();
331      };      };
332    
# Line 723  namespace gig { Line 729  namespace gig {
729              void PrintMessage();              void PrintMessage();
730      };      };
731    
732        String libraryName();
733        String libraryVersion();
734    
735  } // namespace gig  } // namespace gig
736    
737  #endif // __GIG_H__  #endif // __GIG_H__
Legend:
Removed from v.515  
changed lines
  Added in v.518
  ViewVC Help
Powered by ViewVC