KVIrc 5.2.0
Developer APIs
Public Slots | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
HelpWindow Class Reference

#include <HelpWindow.h>

+ Inheritance diagram for HelpWindow:

Public Slots

void indexingEnd ()
 
void indexingProgress (int iNum)
 
void indexingStart (int iNum)
 
void indexSelected (QListWidgetItem *)
 
void initialSetup ()
 
void refreshIndex ()
 
void searchInIndex (const QString &s)
 
void searchSelected (QListWidgetItem *)
 
void showIndexTopic ()
 
void startSearch ()
 
- Public Slots inherited from KviWindow
void autoRaise ()
 
void dock ()
 
void reloadImages ()
 
void savePropertiesAsDefault ()
 
void undock ()
 

Public Member Functions

HelpWidgethelpWidget ()
 
 HelpWindow (const char *name)
 
QTextBrowser * textBrowser ()
 
 ~HelpWindow ()
 
- Public Member Functions inherited from KviWindow
virtual bool activityMeter (unsigned int *puActivityValue, unsigned int *puActivityTemperature)
 
virtual void applyOptions ()
 
virtual QFrame * buttonContainer ()
 
KviIrcConnectionconnection ()
 Returns the current IRC connection (if any)
 
KviConsoleWindowconsole () const
 Returns the console that this window belongs to.
 
KviIrcContextcontext ()
 
void contextPopup ()
 
QString decodeText (const char *pcText)
 
virtual QTextCodec * defaultTextCodec ()
 
void delayedAutoRaise ()
 
void delayedClose ()
 
void demandAttention ()
 Notify the window manager that this window demands attention.
 
QByteArray encodeText (const QString &szText)
 
void forceTextCodec (QTextCodec *pCodec)
 
virtual void getBaseLogFileName (QString &szBuffer)
 
virtual void getConfigGroupName (QString &szBuffer)
 
void getDefaultLogFileName (QString &szBuffer)
 
void getDefaultLogFileName (QString &szBuffer, QDate date, bool bGzip, unsigned int uDatetimeFormat)
 
virtual void getWindowListTipText (QString &szBuffer)
 
bool hasAttention (AttentionLevel eLevel=VisibleAndActive)
 Returns whether this window is the active one.
 
virtual bool highlightMe (unsigned int uValue)
 
virtual bool highlightMeter (unsigned int *puValue)
 
QString id () const
 Returns the global ID of this window.
 
KviInputinput () const
 
void internalOutput (KviIrcView *pView, int iMsgType, const kvi_wchar_t *pwText, int iFlags=0, const QDateTime &datetime=QDateTime())
 
bool isChannel () const
 
bool isConsole () const
 
bool isDocked () const
 
bool isQuery () const
 
 KviWindow (Type eType, const QString &szName, KviConsoleWindow *pConsole=nullptr)
 Constructs the window object.
 
virtual KviIrcViewlastClickedView () const
 Returns the KviIrcView that was last clicked in this window.
 
const QString & lastLineOfText ()
 
const QString & lastMessageText ()
 
void listWindowTypes ()
 
virtual const QString & localNick ()
 
QTextEncoder * makeEncoder ()
 
unsigned long int numericId () const
 Returns the global ID of this window.
 
virtual void output (int iMsgType, const char *pcFormat,...)
 
virtual void output (int iMsgType, const kvi_wchar_t *pwFormat,...)
 
void output (int iMsgType, const QDateTime &datetime, const char *pcFormat,...)
 
void output (int iMsgType, const QDateTime &datetime, const kvi_wchar_t *pwFormat,...)
 
void output (int iMsgType, const QDateTime &datetime, QString szFmt,...)
 
virtual void output (int iMsgType, QString szFmt,...)
 
virtual void outputNoFmt (int iMsgType, const char *pcText, int iFlags=0, const QDateTime &datetime=QDateTime())
 
virtual void outputNoFmt (int iMsgType, const kvi_wchar_t *pwText, int iFlags=0, const QDateTime &datetime=QDateTime())
 
virtual void outputNoFmt (int iMsgType, const QString &szText, int iFlags=0, const QDateTime &datetime=QDateTime())
 
virtual KviWindowoutputProxy ()
 
virtual void ownAction (const QString &)
 
virtual void ownMessage (const QString &, bool=true)
 
void pasteLastLog ()
 Pastes the most recent channel log into the buffer.
 
virtual const QString & plainTextCaption ()
 
void setFixedCaption (const QString &szCaption)
 
void setProgress (int iProgress)
 Sets the progress for the WindowList item.
 
bool setTextEncoding (const QString &szTextEncoding)
 
void setWindowName (const QString &szName)
 Sets the name of the window.
 
void setWindowTitle (QString &szTitle)
 
KviTalSplittersplitter () const
 Returns the splitter of this window.
 
virtual const QString & target ()
 
QTextCodec * textCodec ()
 
const QString & textEncoding () const
 
virtual void toggleButtonContainer ()
 
Type type () const
 Returns the type of the window.
 
virtual const char * typeString ()
 Returns a descriptive name of the window type.
 
void unhighlight ()
 
void updateBackgrounds (QObject *pObj=nullptr)
 
virtual void updateCaption ()
 
virtual void updateIcon ()
 
KviIrcViewview () const
 Returns the KviIrcView of this window.
 
KviWindowListItemwindowListItem () const
 Returns the windowList item.
 
const QString & windowName () const
 Returns the name of this window.
 
 ~KviWindow ()
 Destroys the window object.
 

Protected Member Functions

void fillCaptionBuffers () override
 
void loadProperties (KviConfigurationFile *cfg) override
 
QPixmap * myIconPtr () override
 
void resizeEvent (QResizeEvent *e) override
 
void saveProperties (KviConfigurationFile *cfg) override
 
- Protected Member Functions inherited from KviWindow
void childEvent (QChildEvent *pEvent) override
 
void childInserted (QWidget *pObject)
 
void childRemoved (QWidget *pObject)
 
virtual void childrenTreeChanged (QWidget *pAdded)
 
void closeEvent (QCloseEvent *pEvent) override
 
void createCryptControllerButton (QWidget *pPar)
 
void createSystemTextEncodingPopup ()
 
void createTextEncodingButton (QWidget *pPar)
 
QToolButton * createToolButton (QWidget *pPar, const char *pcName, KviIconManager::SmallIcon eIcon, const QString &szToolTip, bool bOn)
 
virtual void createWindowListItem ()
 
virtual void destroyWindowListItem ()
 
bool eventFilter (QObject *pObject, QEvent *pEvent) override
 
void fillSingleColorCaptionBuffers (const QString &szName)
 
void focusInEvent (QFocusEvent *) override
 
bool focusNextPrevChild (bool bNext) override
 
void inputMethodEvent (QInputMethodEvent *e) override
 
virtual void lostUserFocus ()
 
void moveEvent (QMoveEvent *pEvent) override
 
virtual void preprocessMessage (QString &szMessage)
 
void setType (Type eType)
 
virtual void triggerCreationEvents ()
 
virtual void triggerDestructionEvents ()
 
virtual void youAreDocked ()
 
virtual void youAreUndocked ()
 

Protected Attributes

QStringList m_foundDocs
 
KviTalHBoxm_pBottomLayout
 
QPushButton * m_pBtnRefreshIndex
 
QPushButton * m_pCancelButton
 
HelpWidgetm_pHelpWidget
 
KviTalListWidgetm_pIndexListWidget
 
QLineEdit * m_pIndexSearch
 
KviTalVBoxm_pIndexTab
 
QProgressBar * m_pProgressBar
 
KviTalListWidgetm_pResultBox
 
KviTalVBoxm_pSearchTab
 
QTabWidget * m_pTabWidget
 
QLineEdit * m_pTermsEdit
 
KviTalVBoxm_pToolBar
 
QStringList m_terms
 
- Protected Attributes inherited from KviWindow
bool m_bIsDocked
 
bool m_bProcessingInputEvent
 
Type m_eType
 
KviTalHBoxm_pButtonBox
 
KviConsoleWindowm_pConsole
 
QWidget * m_pFocusHandler
 
QToolButton * m_pHideToolsButton
 
KviInputm_pInput
 
KviIrcViewm_pIrcView
 
QWidget * m_pLastFocusedChild
 
KviTalSplitterm_pSplitter
 
QTextCodec * m_pTextCodec
 
QToolButton * m_pTextEncodingButton
 
KviWindowListItemm_pWindowListItem
 
QString m_szName
 
QString m_szPlainTextCaption
 
QString m_szTextEncoding
 
unsigned long int m_uId
 

Additional Inherited Members

- Public Types inherited from KviWindow
enum  ActivityTemperature {
  Ice = 0 , VeryCold = 1 , Cold = 2 , Undefined = 3 ,
  Hot = 4 , VeryHot = 5 , Fire = 6
}
 Holds the activity meter in temperature scale. More...
 
enum  ActivityValue {
  None = 0 , VeryLow = 1 , Low = 2 , Medium = 3 ,
  High = 4 , VeryHigh = 5
}
 Holds the activity meter in value scale. More...
 
enum  AttentionLevel { VisibleAndActive = 0 , MainWindowIsVisible = 1 }
 attention levels usable in hasAttention() More...
 
enum  Type {
  Console = 0 , Channel = 1 , Query = 2 , DeadChannel = 3 ,
  DeadQuery = 4 , Editor = 5 , Help = 6 , Terminal = 7 ,
  SocketSpy = 8 , Links = 9 , List = 10 , DccChat = 11 ,
  DccTransfer = 12 , DccCanvas = 13 , DccVoice = 14 , DccVideo = 15 ,
  UserWindow = 16 , Tool = 17 , IOGraph = 18 , DirBrowser = 19 ,
  ScriptEditor = 20 , ScriptObject = 21 , LogView = 22 , Offer = 23 ,
  Debug = 24 , Unknown = 25 , TypeCount = 26
}
 Holds the types of a window; these are used by the KVIrc core and distributed modules. More...
 
- Signals inherited from KviWindow
void windowNameChanged ()
 
- Protected Slots inherited from KviWindow
void childDestroyed ()
 
void cryptControllerFinished ()
 
void cryptSessionInfoDestroyed ()
 
void systemTextEncodingPopupActivated (QAction *pAction)
 
void textEncodingButtonClicked ()
 
void toggleCryptController ()
 
- Static Protected Attributes inherited from KviWindow
static const char * m_typeTable [TypeCount]
 
- Properties inherited from KviWindow
int KviProperty_ChildFocusOwner
 

Constructor & Destructor Documentation

◆ HelpWindow()

HelpWindow::HelpWindow ( const char *  name)

◆ ~HelpWindow()

HelpWindow::~HelpWindow ( )

References g_pHelpWindowList.

Member Function Documentation

◆ fillCaptionBuffers()

void HelpWindow::fillCaptionBuffers ( )
overrideprotectedvirtual

Reimplemented from KviWindow.

References __tr2qs, and KviWindow::m_szPlainTextCaption.

◆ helpWidget()

HelpWidget * HelpWindow::helpWidget ( )
inline

References m_pHelpWidget.

◆ indexingEnd

void HelpWindow::indexingEnd ( )
slot

◆ indexingProgress

void HelpWindow::indexingProgress ( int  iNum)
slot

References m_pProgressBar.

Referenced by HelpWindow().

◆ indexingStart

void HelpWindow::indexingStart ( int  iNum)
slot

◆ indexSelected

void HelpWindow::indexSelected ( QListWidgetItem *  item)
slot

◆ initialSetup

void HelpWindow::initialSetup ( )
slot

◆ loadProperties()

void HelpWindow::loadProperties ( KviConfigurationFile cfg)
overrideprotectedvirtual

◆ myIconPtr()

QPixmap * HelpWindow::myIconPtr ( )
overrideprotectedvirtual

◆ refreshIndex

void HelpWindow::refreshIndex ( )
slot

References g_pDocIndex, and HelpIndex::makeIndex().

Referenced by HelpWindow().

◆ resizeEvent()

void HelpWindow::resizeEvent ( QResizeEvent *  e)
overrideprotected

◆ saveProperties()

void HelpWindow::saveProperties ( KviConfigurationFile cfg)
overrideprotectedvirtual

◆ searchInIndex

void HelpWindow::searchInIndex ( const QString &  s)
slot

References i, m_pIndexListWidget, s, and t.

Referenced by HelpWindow().

◆ searchSelected

void HelpWindow::searchSelected ( QListWidgetItem *  item)
slot

◆ showIndexTopic

void HelpWindow::showIndexTopic ( )
slot

◆ startSearch

void HelpWindow::startSearch ( )
slot

◆ textBrowser()

QTextBrowser * HelpWindow::textBrowser ( )

Member Data Documentation

◆ m_foundDocs

QStringList HelpWindow::m_foundDocs
protected

Referenced by startSearch().

◆ m_pBottomLayout

KviTalHBox* HelpWindow::m_pBottomLayout
protected

◆ m_pBtnRefreshIndex

QPushButton* HelpWindow::m_pBtnRefreshIndex
protected

◆ m_pCancelButton

QPushButton* HelpWindow::m_pCancelButton
protected

Referenced by HelpWindow().

◆ m_pHelpWidget

HelpWidget* HelpWindow::m_pHelpWidget
protected

Referenced by helpWidget(), HelpWindow(), and textBrowser().

◆ m_pIndexListWidget

KviTalListWidget* HelpWindow::m_pIndexListWidget
protected

◆ m_pIndexSearch

QLineEdit* HelpWindow::m_pIndexSearch
protected

◆ m_pIndexTab

KviTalVBox* HelpWindow::m_pIndexTab
protected

Referenced by HelpWindow().

◆ m_pProgressBar

QProgressBar* HelpWindow::m_pProgressBar
protected

◆ m_pResultBox

KviTalListWidget* HelpWindow::m_pResultBox
protected

Referenced by HelpWindow(), and startSearch().

◆ m_pSearchTab

KviTalVBox* HelpWindow::m_pSearchTab
protected

Referenced by HelpWindow().

◆ m_pTabWidget

QTabWidget* HelpWindow::m_pTabWidget
protected

Referenced by HelpWindow().

◆ m_pTermsEdit

QLineEdit* HelpWindow::m_pTermsEdit
protected

Referenced by HelpWindow(), and startSearch().

◆ m_pToolBar

KviTalVBox* HelpWindow::m_pToolBar
protected

Referenced by HelpWindow().

◆ m_terms

QStringList HelpWindow::m_terms
protected

Referenced by startSearch().


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