Class: Wx::CalculateLayoutEvent

Inherits:

Event

• Object
• Object
• Event
• Wx::CalculateLayoutEvent

Defined in:

lib/wx/doc/gen/calculate_layout_event.rb

Overview

This event is sent by LayoutAlgorithm to calculate the amount of the remaining client area that the window should occupy.

Events using this class

The following event-handler methods redirect the events to member method or handler blocks for CalculateLayoutEvent events. Event handler methods:

• EvtHandler#evt_calculate_layout(meth = nil, &block): Process a EVT_CALCULATE_LAYOUT event, which asks the window to take a ‘bite’ out of a rectangle provided by the algorithm.

Category: Events

See Also:

• QueryLayoutInfoEvent
• SashLayoutWindow
• LayoutAlgorithm

Instance Method Summary

• #get_flags ⇒ Integer (also: #flags)

  Returns the flags associated with this event.

• #get_rect ⇒ Wx::Rect (also: #rect)

  Before the event handler is entered, returns the remaining parent client area that the window could occupy.

• #initialize(id = 0) ⇒ Wx::CalculateLayoutEvent constructor

  Constructor.

• #set_flags(flags) ⇒ void (also: #flags=)

  Sets the flags associated with this event.

• #set_rect(rect) ⇒ void (also: #rect=)

  Call this to specify the new remaining parent client area, after the space occupied by the window has been subtracted.

Methods inherited from Event

#clone, #get_event_category, #get_event_object, #get_event_type, #get_id, #get_skipped, #get_timestamp, #is_command_event, #resume_propagation, #set_event_object, #set_event_type, #set_id, #set_timestamp, #should_propagate, #skip, #stop_propagation

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(id = 0) ⇒ Wx::CalculateLayoutEvent

Constructor.

Parameters:

• id (Integer) (defaults to: 0)

# File 'lib/wx/doc/gen/calculate_layout_event.rb', line 29

def initialize(id=0) end

Instance Method Details

#get_flags ⇒ Integer Also known as: flags

Returns the flags associated with this event.

Not currently used.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/calculate_layout_event.rb', line 35

def get_flags; end

#get_rect ⇒ Wx::Rect Also known as: rect

Before the event handler is entered, returns the remaining parent client area that the window could occupy.

When the event handler returns, this should contain the remaining parent client rectangle, after the event handler has subtracted the area that its window occupies.

Returns:

• (Wx::Rect)

# File 'lib/wx/doc/gen/calculate_layout_event.rb', line 42

def get_rect; end

#set_flags(flags) ⇒ void Also known as: flags=

This method returns an undefined value.

Sets the flags associated with this event.

Not currently used.

Parameters:

• flags (Integer)

# File 'lib/wx/doc/gen/calculate_layout_event.rb', line 50

def set_flags(flags) end

#set_rect(rect) ⇒ void Also known as: rect=

This method returns an undefined value.

Call this to specify the new remaining parent client area, after the space occupied by the window has been subtracted.

Parameters:

• rect (Wx::Rect)

# File 'lib/wx/doc/gen/calculate_layout_event.rb', line 56

def set_rect(rect) end