1- namespace LogExpert
1+ namespace LogExpert ;
2+
3+ ///<summary>
4+ ///This is a callback interface. Some of the ILogLineColumnizer functions
5+ ///are called with this interface as an argument. You don't have to implement this interface. It's implemented
6+ ///by LogExpert. You can use it in your own columnizers, if you need it.
7+ ///</summary>
8+ ///<remarks>
9+ ///Implementors of ILogLineColumnizer can use the provided functions to get some more informations
10+ ///about the log file. In the most cases you don't need this interface. It's provided here for special cases.<br></br>
11+ ///<br></br>
12+ ///An example would be when the log lines contains only the time of day but the date is coded in the file name. In this situation
13+ ///you can use the GetFileName() function to retrieve the name of the current file to build a complete timestamp.
14+ ///</remarks>
15+ public interface ILogLineColumnizerCallback
216{
3- ///<summary>
4- ///This is a callback interface. Some of the ILogLineColumnizer functions
5- ///are called with this interface as an argument. You don't have to implement this interface. It's implemented
6- ///by LogExpert. You can use it in your own columnizers, if you need it.
7- ///</summary>
8- ///<remarks>
9- ///Implementors of ILogLineColumnizer can use the provided functions to get some more informations
10- ///about the log file. In the most cases you don't need this interface. It's provided here for special cases.<br></br>
11- ///<br></br>
12- ///An example would be when the log lines contains only the time of day but the date is coded in the file name. In this situation
13- ///you can use the GetFileName() function to retrieve the name of the current file to build a complete timestamp.
14- ///</remarks>
15- public interface ILogLineColumnizerCallback
16- {
17- #region Public methods
17+ #region Public methods
1818
19- /// <summary>
20- /// This function returns the current line number. That is the line number of the log line
21- /// a ILogLineColumnizer function is called for (e.g. the line that has to be painted).
22- /// </summary>
23- /// <returns>The current line number starting at 0</returns>
24- int GetLineNum ( ) ;
19+ /// <summary>
20+ /// This function returns the current line number. That is the line number of the log line
21+ /// a ILogLineColumnizer function is called for (e.g. the line that has to be painted).
22+ /// </summary>
23+ /// <returns>The current line number starting at 0</returns>
24+ int GetLineNum ( ) ;
2525
26- /// <summary>
27- /// This function sets the current line number. That is the line number of the log line
28- /// a ILogLineColumnizer function is called for (e.g. the line that has to be painted).
29- /// </summary>
30- /// <param name="lineNum">line number to be set</param>
31- void SetLineNum ( int lineNum ) ;
32- /// <summary>
33- /// Returns the full file name (path + name) of the current log file.
34- /// </summary>
35- /// <returns>File name of current log file</returns>
36- string GetFileName ( ) ;
26+ /// <summary>
27+ /// This function sets the current line number. That is the line number of the log line
28+ /// a ILogLineColumnizer function is called for (e.g. the line that has to be painted).
29+ /// </summary>
30+ /// <param name="lineNum">line number to be set</param>
31+ void SetLineNum ( int lineNum ) ;
32+ /// <summary>
33+ /// Returns the full file name (path + name) of the current log file.
34+ /// </summary>
35+ /// <returns>File name of current log file</returns>
36+ string GetFileName ( ) ;
3737
38- /// <summary>
39- /// Returns the log line with the given index (zero-based).
40- /// </summary>
41- /// <param name="lineNum">Number of the line to be retrieved</param>
42- /// <returns>A string with line content or null if line number is out of range</returns>
43- ILogLine GetLogLine ( int lineNum ) ;
38+ /// <summary>
39+ /// Returns the log line with the given index (zero-based).
40+ /// </summary>
41+ /// <param name="lineNum">Number of the line to be retrieved</param>
42+ /// <returns>A string with line content or null if line number is out of range</returns>
43+ ILogLine GetLogLine ( int lineNum ) ;
4444
45- /// <summary>
46- /// Returns the number of lines of the logfile.
47- /// </summary>
48- /// <returns>Number of lines.</returns>
49- int GetLineCount ( ) ;
45+ /// <summary>
46+ /// Returns the number of lines of the logfile.
47+ /// </summary>
48+ /// <returns>Number of lines.</returns>
49+ int GetLineCount ( ) ;
5050
51- #endregion
52- }
51+ #endregion
5352}
0 commit comments