xflminterface IF_LogMessageClient : public XF_RefCount

This class represents the log message client interface. It extends XF_RefCount.  XFLAIM does not provide an implementation of this interface.  An application is responsible to implement this interface.  Objects of this type should be created whenever XFLAIM calls the IF_LoggerClient::beginMessage method.  XFLAIM will use the object to format and output a message it wants logged.  The application may choose to write the message to a file, output it to a screen console, do something else, or drop the message.

Method Summary
void

 changeColor - XFLAIM calls this method to set the foreground and background color of its message, or some part of its message.
void

 appendString - XFLAIM calls this method to append a text string to its message.
void  newline - XFLAIM calls this method to insert a new line into the log message.
void  endMessage - XFLAIM calls this method to signal that the current log message is  complete.
void  pushForegroundColor - XFLAIM calls this method to save the current foreground color, prior to setting a new foreground color.
void  popForegroundColor - XFLAIM calls this methodto restore the previously pushed foreground color.
void  pushBackgroundColor - XFLAIM calls this method to save the current background color, prior to setting a new background color.
void  popBackgroundColor - XFLAIM calls this method to restore the previously pushed background color.

 

Method Detail

changeColor

    void changeColor(

            eColorType             eForeColor,
            eColorType             eBackColor);

This is called by XFLAIM to set the foreground and background color of the message it is logging.  The foreground and background colors should apply until the next call to changeColor.

    Parameters In:

eColorType eForeColor The foreground color.
eColorType eBackColor The background color.

    Parameters Out: none.

    See Also: pushForegroundColor, popForegroundColor, pushBackgroundColor, popBackgroundColor, getForegroundColor, getBackgroundColor, setColor

[Back to Top]

appendString

    void appendString(

        char *                 pszStr);

This is called by XFLAIM to append a string to the message it is logging.

    Parameters In:

char * pszStr The text string to append to the log message.

    Parameters Out: none.

[Back to Top]

newline

    void newline( void);

This is called by XFLAIM to append a newline to the log message.

    Parameters In: none.

    Parameters Out: none.

[Back to Top]

endMessage

    void endMessage( void);

This is called by XFLAIM to end the current log message.  The implementer of this interface should consider the message complete and take steps to log it to a file, output to a screen, or do whatever it is going to do with the message.

    Parameters In: none.

    Parameters Out: none.

[Back to Top]

pushForegroundColor

    void pushForegroundColor( void);

This is called by XFLAIM to save the current foreground color, prior to setting a new foreground color.  This method would typically be used to introduce a new color in the middle of a log message.  With this method, XFLAIM does not need to know the current foreground color in order to reset it.

    Parameters In: none.

    Parameters Out: none.

    See Also: changeColor, popForegroundColor, pushBackgroundColor, popBackgroundColor, getForegroundColor, getBackgroundColor, setColor

[Back to Top]

popForegroundColor

    void popForegroundColor( void);

This is called by XFLAIM to restore the previously pushed foreground color.

    Parameters In: none.

    Parameters Out: none.

    See Also: changeColor, pushForegroundColor, pushBackgroundColor, popBackgroundColor, getForegroundColor, getBackgroundColor, setColor

[Back to Top]

pushBackgroundColor

    void pushBackgroundColor( void);

This is called by XFLAIM to save the current background color, prior to setting a new background color.  This method would typically be used to introduce a new color in the middle of a log message.  With this method, XFLAIM does not need to know the current background color in order to reset it.

    Parameters In: none.

    Parameters Out: none.

    See Also: changeColor, pushForegroundColor, popForegroundColor, popBackgroundColor, getForegroundColor, getBackgroundColor, setColor

[Back to Top]

popBackgroundColor

    void popBackgroundColor( void);

This is called by XFLAIM to restore the previously pushed background color.

    Parameters In: none.

    Parameters Out: none.

    See Also: changeColor, pushForegroundColor, popForegroundColor, pushBackgroundColor, getForegroundColor, getBackgroundColor, setColor

[Back to Top]