PM Library classes

class PMHelpWindow

? ^ 
    extends PMNonCopyable as public

Help window class.

The PMHelpWindow class provides help for application windows. Typically, you create a PMHelpWindow object and associate it with the primary windows of your application. Multiple help windows can also exist within an application.

You can construct and destruct objects of this class.

Source:
pm_helpwindow.h:28
Author:
Dmitry A.Steklenev
Version:
$Revision: 1.5 $

Contents

^ 
EntityInherited FromTypeScopeShort Description
PMHelpWindowconstructor public Constructs the help window object.
PMHelpWindowconstructor public Wraps the help window object around an existing associated application window.
~PMHelpWindowdestructor public Destructs the help window object.
attachmethod publicAssociates the help window with the specified application window.
detachmethod publicDisassociates the help window from a window.
librarymethod publicIdentifies a help window library name.
showmethod publicTells the help manager to display a specific help window.

constructor PMHelpWindow

? ^  > 
Constructs the help window object.

Source:
pm_helpwindow.h:40
Params:
res_id Resource identifier for a help table resource.
title Window title for the main help window of this help instance.
library A help library to use by IPF. IPF searches these help library for the help panels that it displays.
Code:
public PMHelpWindow ( SHORT res_id ,
const char * title ,
const char * library = NULL )

constructor PMHelpWindow

? ^  < > 
Wraps the help window object around an existing associated application window.
Source:
pm_helpwindow.h:47
Code:
public PMHelpWindow ( HWND hwnd )

destructor ~PMHelpWindow

? ^  < > 
Destructs the help window object.
Source:
pm_helpwindow.h:53
Code:
public virtual ~ PMHelpWindow ( )

method attach

? ^  < > 
Associates the help window with the specified application window.
Source:
pm_helpwindow.h:56
Code:
public virtual void attach ( HWND hwnd )

method detach

? ^  < > 
Disassociates the help window from a window.
Source:
pm_helpwindow.h:58
Code:
public virtual void detach ( )

method library

? ^  < > 
Identifies a help window library name.
Source:
pm_helpwindow.h:61
Code:
public virtual void library ( const char * filename )

method show

? ^  < > 
Tells the help manager to display a specific help window.
Source:
pm_helpwindow.h:63
Code:
public virtual void show ( SHORT res_id )

Created Fri Aug 3 09:13:16 2012.
This documentation was generated automatically by
ccdoc v08r39 2003/02/27 bin_opt_emx_os2-2.30.
Click here to submit a bug report or feature request for ccdoc.
Click here to return to the top of the page.