Class: Wx::QueryLayoutInfoEvent

Inherits:
Event show all
Defined in:
lib/wx/doc/gen/query_layout_info_event.rb

Overview

This event is sent when LayoutAlgorithm wishes to get the size, orientation and alignment of a window.

More precisely, the event is sent by the OnCalculateLayout handler which is itself invoked by LayoutAlgorithm.

Events using this class

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

Category: Events

See Also:

Instance Method Summary collapse

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::QueryLayoutInfoEvent

Constructor.

Parameters:

  • id (Integer) (defaults to: 0) 


30
 
# File 'lib/wx/doc/gen/query_layout_info_event.rb', line 30

def initialize(id=0) end

Instance Method Details

#get_alignment ⇒ Wx::LayoutAlignment Also known as: alignment

Specifies the alignment of the window (which side of the remaining parent client area the window sticks to).

One of LayoutAlignment::LAYOUT_TOP, LayoutAlignment::LAYOUT_LEFT, LayoutAlignment::LAYOUT_RIGHT, LayoutAlignment::LAYOUT_BOTTOM.

Returns:



36
 
# File 'lib/wx/doc/gen/query_layout_info_event.rb', line 36

def get_alignment; end

#get_flags ⇒ Integer Also known as: flags

Returns the flags associated with this event.

Not currently used.

Returns:

  • (Integer) 


43
 
# File 'lib/wx/doc/gen/query_layout_info_event.rb', line 43

def get_flags; end

#get_orientation ⇒ Wx::LayoutOrientation Also known as: orientation

Returns the orientation that the event handler specified to the event object.

May be one of LayoutOrientation::LAYOUT_HORIZONTAL, LayoutOrientation::LAYOUT_VERTICAL.

Returns:



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

def get_orientation; end

#get_requested_length ⇒ Integer Also known as: requested_length

Returns the requested length of the window in the direction of the window orientation.

This information is not yet used.

Returns:

  • (Integer) 


57
 
# File 'lib/wx/doc/gen/query_layout_info_event.rb', line 57

def get_requested_length; end

#get_size ⇒ Wx::Size Also known as: size

Returns the size that the event handler specified to the event object as being the requested size of the window.

Returns:



62
 
# File 'lib/wx/doc/gen/query_layout_info_event.rb', line 62

def get_size; end

#set_alignment(alignment) ⇒ void Also known as: alignment=

This method returns an undefined value.

Call this to specify the alignment of the window (which side of the remaining parent client area the window sticks to).

May be one of LayoutAlignment::LAYOUT_TOP, LayoutAlignment::LAYOUT_LEFT, LayoutAlignment::LAYOUT_RIGHT, LayoutAlignment::LAYOUT_BOTTOM.

Parameters:



70
 
# File 'lib/wx/doc/gen/query_layout_info_event.rb', line 70

def set_alignment(alignment) 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) 


78
 
# File 'lib/wx/doc/gen/query_layout_info_event.rb', line 78

def set_flags(flags) end

#set_orientation(orientation) ⇒ void Also known as: orientation=

This method returns an undefined value.

Call this to specify the orientation of the window.

May be one of LayoutOrientation::LAYOUT_HORIZONTAL, LayoutOrientation::LAYOUT_VERTICAL.

Parameters:



86
 
# File 'lib/wx/doc/gen/query_layout_info_event.rb', line 86

def set_orientation(orientation) end

#set_requested_length(length) ⇒ void Also known as: requested_length=

This method returns an undefined value.

Sets the requested length of the window in the direction of the window orientation.

This information is not yet used.

Parameters:

  • length (Integer) 


94
 
# File 'lib/wx/doc/gen/query_layout_info_event.rb', line 94

def set_requested_length(length) end

#set_size(size) ⇒ void Also known as: size=

This method returns an undefined value.

Call this to let the calling code know what the size of the window is.

Parameters:

  • size (Array(Integer, Integer), Wx::Size) 


100
 
# File 'lib/wx/doc/gen/query_layout_info_event.rb', line 100

def set_size(size) end