KPageWidget

KDE 4.2 PyKDE API Reference

- KDE's Python API

# KPageWidget Class Reference

`from PyKDE4.kdeui import *`

Inherits: KPageView → QWidget → QObject

## Detailed Description

Page widget with many layouts (faces).

See also:
  KPageView with hierarchical page model.

Author:
  Tobias Koenig (tokoe@kde.org)

## Signals
| currentPageChanged (KPageWidgetItem current, KPageWidgetItem before)
| pageRemoved (KPageWidgetItem page)
| pageToggled (KPageWidgetItem page, bool checked)
## Methods
| __init__ (self, QWidget parent=0)
| __init__ (self, KPageWidgetPrivate dd, QWidget parent)
KPageWidgetItem | addPage (self, QWidget widget, QString name)
| addPage (self, KPageWidgetItem item)
KPageWidgetItem | addSubPage (self, KPageWidgetItem parent, QWidget widget, QString name)
| addSubPage (self, KPageWidgetItem parent, KPageWidgetItem item)
KPageWidgetItem | currentPage (self)
| currentPageChanged (self, KPageWidgetItem current, KPageWidgetItem before)
KPageWidgetItem | insertPage (self, KPageWidgetItem before, QWidget widget, QString name)
| insertPage (self, KPageWidgetItem before, KPageWidgetItem item)
| pageRemoved (self, KPageWidgetItem page)
| pageToggled (self, KPageWidgetItem page, bool checked)
| removePage (self, KPageWidgetItem item)
| setCurrentPage (self, KPageWidgetItem item)

## Method Documentation

__init__ | ( | self, |
|  | QWidget | parent=0
| ) |  |  |

Creates a new page widget.

Parameters:

  | parent | The parent widget.

__init__ | ( | self, |
|  | KPageWidgetPrivate | dd,
|  | QWidget | parent
| ) |  |  |

KPageWidgetItem addPage | ( | self, |
|  | QWidget | widget,
|  | QString | name
| ) |  |  |

Adds a new top level page to the widget.

Parameters:

  | widget | The widget of the page.
  | name | The name which is displayed in the navigation view.

Returns:
  The associated
  See also:
    KPageWidgetItem.

addPage | ( | self, |
|  | KPageWidgetItem | item
| ) |  |  |

Adds a new top level page to the widget.

Parameters:

  | item | The See also: KPageWidgetItem which describes the page.

KPageWidgetItem addSubPage | ( | self, |
|  | KPageWidgetItem | parent,
|  | QWidget | widget,
|  | QString | name
| ) |  |  |

Inserts a new sub page in the widget.

Parameters:

    | parent | The new page will be insert as child of this See also: KPageWidgetItem. Parameters:
    | widget | The widget of the page.
    | name | The name which is displayed in the navigation view.
  Returns: The associated See also: KPageWidgetItem.

addSubPage | ( | self, |
|  | KPageWidgetItem | parent,
|  | KPageWidgetItem | item
| ) |  |  |

Inserts a new sub page in the widget.

Parameters:

    | parent | The new page will be insert as child of this See also: KPageWidgetItem. Parameters:
    | item | The See also: KPageWidgetItem which describes the page.

KPageWidgetItem currentPage | ( |  | self ) |

Returns the

See also:
  KPageWidgetItem for the current page or 0 if there is no current page.

currentPageChanged | ( | self, |
|  | KPageWidgetItem | current,
|  | KPageWidgetItem | before
| ) |  |  |

This signal is emitted whenever the current page has changed.

Parameters:

  | item | The new current page or 0 if no current page is available.

Signal syntax:
  `QObject.connect(source, SIGNAL("currentPageChanged(KPageWidgetItem*, KPageWidgetItem*)"), target_slot)`

KPageWidgetItem insertPage | ( | self, |
|  | KPageWidgetItem | before,
|  | QWidget | widget,
|  | QString | name
| ) |  |  |

Inserts a new page in the widget.

Parameters:

    | before | The new page will be insert before this See also: KPageWidgetItem on the same level in hierarchy. Parameters:
    | widget | The widget of the page.
    | name | The name which is displayed in the navigation view.
  Returns: The associated See also: KPageWidgetItem.

insertPage | ( | self, |
|  | KPageWidgetItem | before,
|  | KPageWidgetItem | item
| ) |  |  |

Inserts a new page in the widget.

Parameters:

    | before | The new page will be insert before this See also: KPageWidgetItem on the same level in hierarchy. Parameters:
    | item | The See also: KPageWidgetItem which describes the page.

pageRemoved | ( | self, |
|  | KPageWidgetItem | page
| ) |  |  |

This signal is emitted when a page is removed.

Parameters:

  | page | The page which is removed

Signal syntax:
  `QObject.connect(source, SIGNAL("pageRemoved(KPageWidgetItem*)"), target_slot)`

pageToggled | ( | self, |
|  | KPageWidgetItem | page,
|  | bool | checked
| ) |  |  |

This signal is emitted whenever a checkable page changes its state.

Parameters:

  | checked | is true when the
  | page | is checked, or false if the
  | page | is unchecked.

Signal syntax:
  `QObject.connect(source, SIGNAL("pageToggled(KPageWidgetItem*, bool)"), target_slot)`

removePage | ( | self, |
|  | KPageWidgetItem | item
| ) |  |  |

Removes the page associated with the given

See also:
  KPageWidgetItem.

setCurrentPage | ( | self, |
|  | KPageWidgetItem | item
| ) |  |  |

Sets the page which is associated with the given

See also:
  KPageWidgetItem to be the current page and emits the currentPageChanged() signal.