DPageList

From Dabo Wiki
Jump to: navigation, search

dPageList is one variation on the paged control; instead of using tabs to select pages, the user is given a list control; selecting an item in the list selects the associated page. This is probably the least-used of the paged controls, but is included as an option.


Some of the more useful properties for dPageList:

  • PageClass - (dPage): The default class to use for pages added to the control.
  • PageCount - (int): This isn't just a read-only counting of pages; changing this property will add or delete pages to bring the total number of pages in line.
  • Pages - (list): a read-only list of the pages in this control.
  • PageSizerClass - (dSizer or dGridSizer): When a new page is created, this is the class of the sizer that is automatically added to it.
  • SelectedPage - (dPage): A reference to the currently visible page.
  • SelectedPageNumber - (int): The index of the SelectedPage.
  • TabPosition - (str): Determines which side of the control the tabs appear on. Can be one of: Top (default), Bottom, Left, or Right. Must be passed at construction time; setting it after the control has already been created has no effect.

Some of the more useful methods for dPageList:

  • appendPage(page) - (dPage): Adds a new page to the control. page can be either a page instance or a page class to be instantiated. The page is placed in the last position in the control, and a reference to it is returned.
  • insertPage(pos, page) - (dPage): Adds a new page to the control. page can be either a page instance or a page class to be instantiated. The page is placed in the position specified by pos, and a reference to it is returned.
  • removePage(pgOrPos, delete=True) - (None or dPage): Removes the specified page from the control. You can pass a reference to the page, or its index in the control. If delete is False, the page is not destroyed, and a reference to it is returned. Otherwise, the page is destroyed and None is returned.
  • movePage(oldPgOrPos, newPos, selecting=True) - (None or True): Changes the position of the specified page. If the old and new positions are the same, nothing happens and None is returned; otherwise, the page is moved and True is returned. Unless you pass selecting=False, the specified page is selected.
  • cyclePages(num) - (None): Moves through the pages by the specified amount, wrapping around the ends. Negative values move to previous pages; positive move through the next pages.

See the Dabo Class Documentation for an exhaustive documentation of this control's Properties, Events and Methods. (Note that this documentation is no longer live, but it's still available via the Internet Archive).