# :stopdoc: # This file is automatically generated by the WXRuby3 documentation # generator. Do not alter this file. # :startdoc: module Wx # LB_DEFAULT = 0 # LB_TOP = 16 # LB_BOTTOM = 32 # LB_LEFT = 64 # LB_RIGHT = 128 # LB_ALIGN_MASK = 240 # # EVT_LISTBOOK_PAGE_CHANGED = 10098 # # EVT_LISTBOOK_PAGE_CHANGING = 10097 # {Wx::Listbook} is a class similar to {Wx::Notebook} but which uses a {Wx::ListCtrl} to show the labels instead of the tabs. # The underlying {Wx::ListCtrl} displays page labels in a one-column report view by default. Calling Wx::BookCtrl::SetImageList will implicitly switch the control to use an icon view. # For usage documentation of this class, please refer to the base abstract class {Wx::BookCtrl}. You can also use the Notebook Sample to see {Wx::Listbook} in action. # === Styles # # This class supports the following styles: # # - {Wx::LB_DEFAULT}: Choose the default location for the labels depending on the current platform (left everywhere except Mac where it is top). # # - {Wx::LB_TOP}: Place labels above the page area. # # - {Wx::LB_LEFT}: Place labels on the left side. # # - {Wx::LB_RIGHT}: Place labels on the right side. # # - {Wx::LB_BOTTOM}: Place labels below the page area. # # === Events emitted by this class # # The following event-handler methods redirect the events to member method or handler blocks for {Wx::BookCtrlEvent} events. # Event handler methods for events emitted by this class: # # - {Wx::EvtHandler#evt_listbook_page_changed}(id, meth = nil, &block): The page selection was changed. Processes a {Wx::EVT_LISTBOOK_PAGE_CHANGED} event. # # - {Wx::EvtHandler#evt_listbook_page_changing}(id, meth = nil, &block): The page selection is about to be changed. Processes a {Wx::EVT_LISTBOOK_PAGE_CHANGING} event. This event can be vetoed. # # === # # Category: Book Controls
Appearance:
wxMSW Appearance # wxGTK Appearance # wxOSX Appearance #
# @see Wx::BookCtrl # @see Wx::Notebook # @see Notebook Sample # # class Listbook < BookCtrlBase # @overload initialize() # Default ctor. # @return [Wx::Listbook] # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=('')) # Constructs a listbook control. # @param parent [Wx::Window] # @param id [Integer] # @param pos [Array(Integer, Integer), Wx::Point] # @param size [Array(Integer, Integer), Wx::Size] # @param style [Integer] # @param name [String] # @return [Wx::Listbook] def initialize(*args) end # Create the list book control that has already been constructed with the default constructor. # @param parent [Wx::Window] # @param id [Integer] # @param pos [Array(Integer, Integer), Wx::Point] # @param size [Array(Integer, Integer), Wx::Size] # @param style [Integer] # @param name [String] # @return [Boolean] def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=('')) end # Returns the {Wx::ListView} associated with the control. # @return [Wx::ListView] def get_list_view; end alias_method :list_view, :get_list_view end # Listbook end