Class: Wx::PG::PropertyGridPageState

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/pg/property_grid_page_state.rb

Overview

Contains low-level property page information (properties, column widths, etc.) of a single PropertyGrid or single PropertyGridPage.

Generally you should not use this class directly, but instead member functions in PropertyGridInterface, PropertyGrid, PropertyGridPage, and PropertyGridManager.

Remark:

Currently this class is not implemented in Wx::Python.

Category: PropertyGrid

Requires:

  • USE_PROPGRID

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Wx::PG::PropertyGridPageState

Default constructor.



28
 
# File 'lib/wx/doc/gen/pg/property_grid_page_state.rb', line 28

def initialize; end

Instance Method Details

#check_column_widths(widthChange = 0) ⇒ void

This method returns an undefined value.

Makes sure all columns have minimum width.

Parameters:

  • widthChange (Integer) (defaults to: 0) 


33
 
# File 'lib/wx/doc/gen/pg/property_grid_page_state.rb', line 33

def check_column_widths(widthChange=0) end

#enable_categories(enable) ⇒ Boolean

Parameters:

  • enable (Boolean)

Returns:

  • (Boolean) 


37
 
# File 'lib/wx/doc/gen/pg/property_grid_page_state.rb', line 37

def enable_categories(enable) end

#ensure_virtual_height ⇒ void

This method returns an undefined value.

Make sure virtual height is up-to-date.



41
 
# File 'lib/wx/doc/gen/pg/property_grid_page_state.rb', line 41

def ensure_virtual_height; end

#get_actual_virtual_height ⇒ Integer Also known as: actual_virtual_height

Returns actual height of contained visible properties.

Remark:

Mostly used for internal diagnostic purposes.

Returns:

  • (Integer) 


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

def get_actual_virtual_height; end

#get_column_count ⇒ Integer Also known as: column_count

Returns:

  • (Integer) 


60
 
# File 'lib/wx/doc/gen/pg/property_grid_page_state.rb', line 60

def get_column_count; end

#get_column_full_width(p, col) ⇒ Integer Also known as: column_full_width

Parameters:

Returns:

  • (Integer) 


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

def get_column_full_width(p, col) end

#get_column_min_width(column) ⇒ Integer Also known as: column_min_width

Parameters:

  • column (Integer)

Returns:

  • (Integer) 


65
 
# File 'lib/wx/doc/gen/pg/property_grid_page_state.rb', line 65

def get_column_min_width(column) end

#get_column_width(column) ⇒ Integer Also known as: column_width

Parameters:

  • column (Integer)

Returns:

  • (Integer) 


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

def get_column_width(column) end

#get_grid ⇒ Wx::PG::PropertyGrid Also known as: grid

Returns:



74
 
# File 'lib/wx/doc/gen/pg/property_grid_page_state.rb', line 74

def get_grid; end

#get_last_item(flags = Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_DEFAULT) ⇒ Wx::PG::PGProperty Also known as: last_item

Parameters:

  • flags (Integer) (defaults to: Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_DEFAULT)

Returns:



79
 
# File 'lib/wx/doc/gen/pg/property_grid_page_state.rb', line 79

def get_last_item(flags=Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_DEFAULT) end

#get_property_category(p) ⇒ Wx::PG::PropertyCategory Also known as: property_category

Parameters:

Returns:



89
 
# File 'lib/wx/doc/gen/pg/property_grid_page_state.rb', line 89

def get_property_category(p) end

#get_selection ⇒ Wx::PG::PGProperty Also known as: selection

Returns currently selected property.

Returns:



84
 
# File 'lib/wx/doc/gen/pg/property_grid_page_state.rb', line 84

def get_selection; end

#get_virtual_height ⇒ Integer Also known as: virtual_height

Returns (precalculated) height of contained visible properties.

Returns:

  • (Integer) 


45
 
# File 'lib/wx/doc/gen/pg/property_grid_page_state.rb', line 45

def get_virtual_height; end

#get_virtual_width ⇒ Integer Also known as: virtual_width

Returns combined width of margin and all the columns.

Returns:

  • (Integer) 


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

def get_virtual_width; end

#hit_test(pt) ⇒ Wx::PG::PropertyGridHitTestResult

Returns information about arbitrary position in the grid.

Parameters:

  • pt (Array(Integer, Integer), Wx::Point) —

    Logical coordinates in the virtual grid space. Use Wx::Scrolled<T>#calc_unscrolled_position if you need to translate a scrolled position into a logical one.

Returns:



106
 
# File 'lib/wx/doc/gen/pg/property_grid_page_state.rb', line 106

def hit_test(pt) end

#is_displayed ⇒ Boolean Also known as: displayed?

Returns true if page is visibly displayed.

Returns:

  • (Boolean) 


110
 
# File 'lib/wx/doc/gen/pg/property_grid_page_state.rb', line 110

def is_displayed; end

#is_in_non_cat_mode ⇒ Boolean Also known as: in_non_cat_mode?

Returns:

  • (Boolean) 


114
 
# File 'lib/wx/doc/gen/pg/property_grid_page_state.rb', line 114

def is_in_non_cat_mode; end

#virtual_height_changed ⇒ void

This method returns an undefined value.

Called after virtual height needs to be recalculated.



119
 
# File 'lib/wx/doc/gen/pg/property_grid_page_state.rb', line 119

def virtual_height_changed; end