### INotebook::PageSettings

  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.

#### Portability Considerations

  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.

### INotebook::PageSettings - Member Functions and Data by Group

### Constructors & Destructor

You can construct and destruct objects of this class.

~PageSettings

      public:
      virtual ~PageSettings()

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

PageSettings

  You can create objects of this class by specifying various parameters.

  Overload 1

      public:
      PageSettings(const INotebook::PageSettings& pageSettings)

  pageSettings
    Reference to the page settings object to copy.

  Use this constructor to copy another INotebook::PageSettings object.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

  Overload 2

      public:
      PageSettings( const IBitmapHandle& tabBitmap,
                    const char* statusText = 0,
                    const Attribute& pageAttribute = noAttribute )

  tabBitmap
    Reference to the handle of the bitmap to use on the notebook page's tab.
  statusText
    Pointer to the text to use on the status line of the notebook page.
  pageAttribute
    Reference to an INoteBook::PageSettings::Attribute object. The default is INotebook::PageSettings::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.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

  Overload 3

      public:
      PageSettings(const Attribute& attribute)

  attribute
    Reference to an INoteBook::PageSettings::Attribute object.

  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.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

  Overload 4

      public:
      PageSettings( const char* tabText,
                    const char* statusText = 0,
                    const Attribute& pageAttribute = noAttribute )

  tabText
    Pointer to the text to use on the notebook page's tab.
  statusText
    Pointer to the text to use on the status line of the notebook page.
  pageAttribute
    Reference to an INoteBook::PageSettings::Attribute object. The default is INotebook::PageSettings::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.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

  Overload 5

      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.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

### Application Data

Use these members to query and set the application data associated with an INotebook::PageSettings object.
Note: Once an INotebook::PageSettings object has been used to insert a page into a notebook, using these members on the object has no effect on the application data within the actual notebook page. You should use the corresponding application data members located within INotebook. However, you can still use these members to update the application data associated with the INotebook::PageSettings object, and you can use the object to define a new notebook page.

setUserData

      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.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

userData

      public:
      virtual unsigned long userData() const

  Returns the application data from the page's reserved storage.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

### Assignment Operator

Use the assignment operator to assign the specified INotebook::PageSettings object to the target one.

operator =

      public:
      PageSettings&
        operator =( const INotebook::PageSettings& pageSettings )

  Assigns an INotebook::PageSettings object to reference an existing page settings object.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

### Attributes

These members define the various attributes that are associated with a notebook page.

autoPageSize

      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.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

majorTab

      public:
      static const Attribute majorTab

  Specifies that the page is associated with a major tab.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

minorTab

      public:
      static const Attribute minorTab

  Specifies that the page is associated with a minor tab.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

noAttribute

      public:
      static const Attribute noAttribute

  Specifies that no attribute applies to the notebook page.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

statusTextOn

      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.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

AIX Considerations

  The status text area is always present in AIX notebooks. Therefore, this Attribute has no effect on that platform.

### Automatic Sizing

Use these members to determine if the page is automatically sized by the notebook.

isAutoSize

      public:
      bool isAutoSize() const

  Queries whether the page is automatically sized by the notebook and returns true if it is.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

### Status Text

Use these members to query and set the status text associated with an INotebook::PageSettings object.
Note: Once an INotebook::PageSettings object has been used to insert a page into a notebook, using these members on the object has no effect on the status text within the actual notebook page. You should use the corresponding status text members located within INotebook. However, you can still use these members to update the status text associated with the INotebook::PageSettings object, and you can use the object to define a new notebook page.

isStatusTextOn

      public:
      bool isStatusTextOn() const

  Queries whether a status line is associated with the page and returns true if one is.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

AIX Considerations

  The status text area is always present in AIX notebooks. Therefore, this function always returns true on that platform.

setStatusText

  Sets the text of the status line associated with this page. Calling this function adds the INotebook::PageSettings::statusTextOn attribute to the settings object.

  Overload 1

      public:
      virtual INotebook::PageSettings&
        setStatusText( const char* statusText )

  statusText
    Pointer to the text to use on the status line of the notebook page.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

  Overload 2

      public:
      virtual INotebook::PageSettings&
        setStatusText( const IResourceId& resourceId )

  resourceId
    Reference to a resource identifier object that identifies the text to use on the status line of the notebook page.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

statusText

      public:
      virtual IString statusText() const

  Returns the text of the status line associated with this page.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

### Tabs

Use these members to query and set the tab's text or bitmap associated with an INotebook::PageSettings object.
Note: Once an INotebook::PageSettings object has been used to insert a page into a notebook, using these members on the object has no effect on the notebook page's tab. You should use the corresponding tab members located within INotebook. However, you can still use these members to update the tab text or bitmap associated with the INotebook::PageSettings object, and you can use the object to define a new notebook page.

isMajorTab

      public:
      bool isMajorTab() const

  Queries whether a major tab is associated with the page and returns true if one is.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

isMinorTab

      public:
      bool isMinorTab() const

  Queries whether a minor tab is associated with the page and returns true if one is.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

setTabBitmap

  Sets the bitmap of the tab associated with this page.

  Overload 1

      public:
      virtual INotebook::PageSettings&
        setTabBitmap( const IBitmapHandle& bitmap )

  bitmap
    Reference to the handle of the bitmap to use on the notebook page's tab.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

  Overload 2

      public:
      virtual INotebook::PageSettings&
        setTabBitmap( const IResourceId& resourceId )

  resourceId
    Reference to a resource identifier object that identifies the bitmap to use on the notebook page's tab.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

setTabText

  Sets the text of the tab associated with this page.
  Note: Multiple lines of text on the tabs are not supported. You must use the tab owner draw support to implement multiline text.

  Overload 1

      public:
      virtual INotebook::PageSettings&
        setTabText( const IResourceId& resourceId )

  resourceId
    Reference to a resource identifier object that identifies the text to use on the notebook page's tab.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

  Overload 2

      public:
      virtual INotebook::PageSettings&
        setTabText( const char* tabText )

  tabText
    Pointer to the text to use on the notebook page's tab.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

tabBitmap

      public:
      virtual IBitmapHandle tabBitmap() const

  Returns the bitmap of the tab associated with this page.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

tabText

      public:
      virtual IString tabText() const

  Returns the text of the tab associated with this page.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

### INotebook::PageSettings - Inherited Member Functions and Data

#### Inherited Public Functions

  - None

#### Inherited Public Data

  - None

#### Inherited Protected Functions

  - None

#### Inherited Protected Data

  - None