Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class notebook

boost::ui::notebook — Widget that is an array of tabbed widgets.

Synopsis

// In header: <boost/ui/notebook.hpp>


class notebook : public boost::ui::widget {
public:
  // types
  typedef index_type size_type;  // Unsigned integral type. 

  // construct/copy/destruct
  explicit notebook(widget &);
  notebook();

  // public member functions
  void append_page(widget &, const uistring &);
  void current_page(size_type);
  size_type current_page_index() const;

  // private member functions
  detail_impl * get_impl();
  const detail_impl * get_impl() const;

  // public data members
  static const size_type npos;  // Invalid page index. 
};

Description

See Also:

Tab (Wikipedia)

notebook public construct/copy/destruct

  1. explicit notebook(widget & parent);
    Creates notebook widget.
  2. notebook();

notebook public member functions

  1. void append_page(widget & page, const uistring & label);
    Appends page with associated label.
  2. void current_page(size_type index);
    Shows page with index.
  3. size_type current_page_index() const;
    Returns index of the current page. If notebook has no pages then returns npos.

notebook private member functions

  1. detail_impl * get_impl();
  2. const detail_impl * get_impl() const;

PrevUpHomeNext