Logo Search packages:      
Sourcecode: inkscape version File versions

Inkscape::MessageContext Class Reference

#include <message-context.h>

List of all members.


Detailed Description

A convenience class for working with MessageStacks.

In general, a particular piece of code will only want to display one status message at a time. This class takes care of tracking a "current" message id in a particular stack for us, and provides a convenient means to remove or replace it.

See also:
Inkscape::MessageStack

Definition at line 34 of file message-context.h.


Public Member Functions

void clear ()
 removes our current message from the stack
void flash (MessageType type, gchar const *message)
 pushes a message onto the stack for a brief period of time without disturbing our "current" message
void flashF (MessageType type, gchar const *format,...)
 pushes a message onto the stack for a brief period of time using printf-style formatting, without disturbing our current message
void flashVF (MessageType type, gchar const *format, va_list args)
 pushes a message onto the stack for a brief period of time using printf-style formatting and a stdarg argument list; it does not disturb our "current" message
 MessageContext (MessageStack *stack)
void set (MessageType type, gchar const *message)
 pushes a message on the stack, replacing our old message
void setF (MessageType type, gchar const *format,...)
 pushes a message on the stack using prinf-style formatting, and replacing our old message
void setVF (MessageType type, gchar const *format, va_list args)
 pushes a message on the stack using printf-style formatting, and a stdarg argument list

Private Attributes

MessageId _flash_message_id
 current flashed message id, or 0
MessageId _message_id
 our current message id, or 0
MessageStack_stack
 the message stack to use

The documentation for this class was generated from the following files:

Generated by  Doxygen 1.6.0   Back to index