The nested class INotebook::PageSettings identifies information about a page in a notebook. You create objects of this nested class to define characteristics of pages when adding the pages to a notebook. You can use one object of this nested class to create multiple pages that have the same characteristics.
You can also create an object of this nested class to reflect the current state of a page in a notebook.
The INotebook::PageSettings object only identifies the characteristics of a page at one point in time, such as when you are adding the page to a notebook. The object is not updated when the actual page changes. Also, changes to the INotebook::PageSettings object are not reflected in the actual page after it is added to a notebook.
The INotebook's implementation of the Windows tab control only supports major tab pages. However, it will convert all minor and non-tab pages in your existing application to major tab pages.
The Windows tab control contains no status text line. The INotebook's implementation of this control ignores the status text and text alignment settings.
You can construct and destruct objects of this class.
![]() |
public:
virtual ~PageSettings()
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
You can create objects of this class by specifying various parameters.
public:
PageSettings(const INotebook::PageSettings& pageSettings)
Use this constructor to copy another INotebook::PageSettings object.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
public:
PageSettings( const IBitmapHandle& tabBitmap, const char* statusText = 0, const Attribute& pageAttribute = noAttribute )
You can construct an object of this nested class by using the tab bitmap, status text, and one or more attributes. Use this constructor when you do not want to specify text for the tab.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
public:
PageSettings(const Attribute& attribute)
You can create an object of this nested class by using one or more page attributes. All of the other page settings are set to 0.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
public:
PageSettings( const char* tabText, const char* statusText = 0, const Attribute& pageAttribute = noAttribute )
You can create an object of this nested class by using the tab text, status text, and one or more attributes. Use this constructor when you do not want to specify a bitmap for the tab.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
public:
PageSettings()
You can create an object of this nested class by using this, the default constructor. The Open Class Library defines the default attribute to be INotebook::PageSettings::noAttribute, and all of the other page settings values are set to 0.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to query and set the application data associated
with an INotebook::PageSettings object.
Note:
![]() |
public:
virtual INotebook::PageSettings& setUserData( unsigned long userData )
Sets the application data into the page's reserved storage. Each page has a 4-byte reserved storage area. This area is available for information required by your application.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual unsigned long userData() const
Returns the application data from the page's reserved storage.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use the assignment operator to assign the specified INotebook::PageSettings object to the target one.
![]() |
public:
PageSettings& operator =( const INotebook::PageSettings& pageSettings )
Assigns an INotebook::PageSettings object to reference an existing page settings object.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
These members define the various attributes that are associated with a notebook page.
![]() |
public:
static const Attribute autoPageSize
Specifies the positioning and sizing of the notebook page. When you create a page using this attribute, the system resizes the window associated with the page so that it fills in the page area.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
static const Attribute majorTab
Specifies that the page is associated with a major tab.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
static const Attribute minorTab
Specifies that the page is associated with a minor tab.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
static const Attribute noAttribute
Specifies that no attribute applies to the notebook page.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
static const Attribute statusTextOn
Specifies that the page has a status line. You cannot assign status text to a page without a status line.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
The status text area is always present in AIX notebooks. Therefore, this Attribute has no effect on that platform.
Use these members to determine if the page is automatically sized by the notebook.
![]() |
public:
bool isAutoSize() const
Queries whether the page is automatically sized by the notebook and returns true if it is.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to query and set the status text associated
with an INotebook::PageSettings object.
Note:
![]() |
public:
bool isStatusTextOn() const
Queries whether a status line is associated with the page and returns true if one is.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
The status text area is always present in AIX notebooks. Therefore, this function always returns true on that platform.
![]() |
Sets the text of the status line associated with this page. Calling this function adds the INotebook::PageSettings::statusTextOn attribute to the settings object.
public:
virtual INotebook::PageSettings& setStatusText( const char* statusText )
Windows | OS/2 | AIX |
Yes | Yes | Yes |
public:
virtual INotebook::PageSettings& setStatusText( const IResourceId& resourceId )
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IString statusText() const
Returns the text of the status line associated with this page.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to query and set the tab's text or bitmap associated
with an INotebook::PageSettings object.
Note:
![]() |
public:
bool isMajorTab() const
Queries whether a major tab is associated with the page and returns true if one is.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
bool isMinorTab() const
Queries whether a minor tab is associated with the page and returns true if one is.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
Sets the bitmap of the tab associated with this page.
public:
virtual INotebook::PageSettings& setTabBitmap( const IBitmapHandle& bitmap )
Windows | OS/2 | AIX |
Yes | Yes | Yes |
public:
virtual INotebook::PageSettings& setTabBitmap( const IResourceId& resourceId )
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
Sets the text of the tab associated with this page.
Note:
public:
virtual INotebook::PageSettings& setTabText( const IResourceId& resourceId )
Windows | OS/2 | AIX |
Yes | Yes | Yes |
public:
virtual INotebook::PageSettings& setTabText( const char* tabText )
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IBitmapHandle tabBitmap() const
Returns the bitmap of the tab associated with this page.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IString tabText() const
Returns the text of the tab associated with this page.
Windows | OS/2 | AIX |
Yes | Yes | Yes |