KexiDB::MessageHandler Class Referenceabstract

#include <msghandler.h>

Inherited by KexiGUIMessageHandler, and ObjectStatusMessageHandler.

Public Types

enum  MessageType { Error , Sorry , Warning }
 

Public Member Functions

 MessageHandler (TQWidget *parent=0)
 
void enableMessages (bool enable)
 
virtual void showErrorMessage (const TQString &title, const TQString &details=TQString())=0
 
virtual void showErrorMessage (KexiDB::Object *obj, const TQString &msg=TQString())=0
 
virtual int askQuestion (const TQString &message, KMessageBox::DialogType dlgType, KMessageBox::ButtonCode defaultResult, const KGuiItem &buttonYes=KStdGuiItem::yes(), const KGuiItem &buttonNo=KStdGuiItem::no(), const TQString &dontShowAskAgainName=TQString(), int options=KMessageBox::Notify)
 

Protected Attributes

TQGuardedPtr< TQWidget > m_messageHandlerParentWidget
 
bool m_enableMessages: 1
 

Detailed Description

A prototype for Message Handler usable for reacting on messages sent by KexiDB::Object object(s).

Definition at line 52 of file msghandler.h.

Member Enumeration Documentation

◆ MessageType

enum KexiDB::MessageHandler::MessageType

Definition at line 55 of file msghandler.h.

Constructor & Destructor Documentation

◆ MessageHandler()

MessageHandler::MessageHandler ( TQWidget *  parent = 0)

Constructs mesage handler, parent is a widget that will be a parent for displaying gui elements (e.g. message boxes). Can be 0 for non-gui usage.

Definition at line 38 of file msghandler.cpp.

◆ ~MessageHandler()

MessageHandler::~MessageHandler ( )
virtual

Definition at line 44 of file msghandler.cpp.

Member Function Documentation

◆ askQuestion()

int MessageHandler::askQuestion ( const TQString &  message,
KMessageBox::DialogType  dlgType,
KMessageBox::ButtonCode  defaultResult,
const KGuiItem &  buttonYes = KStdGuiItem::yes(),
const KGuiItem &  buttonNo = KStdGuiItem::no(),
const TQString &  dontShowAskAgainName = TQString(),
int  options = KMessageBox::Notify 
)
virtual

Interactively asks a question. For GUI version, KMessageBox class is used. See KMessageBox documentation for explanation of the parameters. defaultResult is returned in case when no message handler is installed. message should be i18n's string. Value from KMessageBox::ButtonCode enum is returned. Reimplement this. This implementation does nothing, just returns defaultResult.

Definition at line 48 of file msghandler.cpp.

◆ enableMessages()

void KexiDB::MessageHandler::enableMessages ( bool  enable)
inline

This method can be used to block/unblock messages. Sometimes you are receiving both lower- and higher-level messages, but you do not need to display two message boxes but only one (higher level with details). All you need is to call enableMessages(false) before action that can fail and restore messages by enableMessages(true) after the action. See KexiMainWindowImpl::renameObject() implementation for example.

Definition at line 68 of file msghandler.h.

◆ showErrorMessage() [1/2]

virtual void KexiDB::MessageHandler::showErrorMessage ( const TQString &  title,
const TQString &  details = TQString() 
)
pure virtual

Shows error message with title (it is not caption) and details.

◆ showErrorMessage() [2/2]

virtual void KexiDB::MessageHandler::showErrorMessage ( KexiDB::Object *  obj,
const TQString &  msg = TQString() 
)
pure virtual

Shows error message with msg text. Existing error message from obj object is also copied, if present.

Member Data Documentation

◆ m_enableMessages

bool KexiDB::MessageHandler::m_enableMessages
protected

Definition at line 93 of file msghandler.h.

◆ m_messageHandlerParentWidget

TQGuardedPtr<TQWidget> KexiDB::MessageHandler::m_messageHandlerParentWidget
protected

Definition at line 92 of file msghandler.h.


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