wxruby3 1.6.1 → 1.7.0

data/lib/wx/doc/gen/pg/pg_validation_info.rb

@@ -0,0 +1,344 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module PG
+
+    # 
+    # 
+    # ## wxPropertyGrid Window Styles
+    # SetWindowStyleFlag method can be used to modify some of these at run-time.
+    # 
+    # @wxrb_require USE_PROPGRID
+    class PG_WINDOW_STYLES < Wx::Enum
+    
+      # This will cause Sort() automatically after an item is added.
+      # 
+      PG_AUTO_SORT = Wx::PG::PG_WINDOW_STYLES.new(16)
+      
+      # Categories are not initially shown (even if added).
+      # 
+      PG_HIDE_CATEGORIES = Wx::PG::PG_WINDOW_STYLES.new(32)
+      
+      # This style combines non-categoric mode and automatic sorting.
+      # 
+      PG_ALPHABETIC_MODE = Wx::PG::PG_WINDOW_STYLES.new(48)
+      
+      # Modified values are shown in bold font.
+      # 
+      PG_BOLD_MODIFIED = Wx::PG::PG_WINDOW_STYLES.new(64)
+      
+      # When {Wx::PG::PropertyGrid} is resized, splitter moves to the center.
+      # 
+      PG_SPLITTER_AUTO_CENTER = Wx::PG::PG_WINDOW_STYLES.new(128)
+      
+      # Display tool tips for cell text that cannot be shown completely.
+      # 
+      PG_TOOLTIPS = Wx::PG::PG_WINDOW_STYLES.new(256)
+      
+      # Disables margin and hides all expand/collapse buttons that would appear outside the margin (for sub-properties).
+      # 
+      PG_HIDE_MARGIN = Wx::PG::PG_WINDOW_STYLES.new(512)
+      
+      # This style prevents user from moving the splitter.
+      # 
+      PG_STATIC_SPLITTER = Wx::PG::PG_WINDOW_STYLES.new(1024)
+      
+      # Combination of other styles that make it impossible for user to modify the layout.
+      # 
+      PG_STATIC_LAYOUT = Wx::PG::PG_WINDOW_STYLES.new(1536)
+      
+      # Disables {Wx::TextCtrl} based editors for properties which can be edited in another way.
+      # 
+      PG_LIMITED_EDITING = Wx::PG::PG_WINDOW_STYLES.new(2048)
+      
+      # {Wx::PG::PropertyGridManager} only: Show tool bar for mode and page selection.
+      # 
+      PG_TOOLBAR = Wx::PG::PG_WINDOW_STYLES.new(4096)
+      
+      # {Wx::PG::PropertyGridManager} only: Show adjustable text box showing description or help text, if available, for currently selected property.
+      # 
+      PG_DESCRIPTION = Wx::PG::PG_WINDOW_STYLES.new(8192)
+      
+      # {Wx::PG::PropertyGridManager} only: don't show an internal border around the property grid.
+      # 
+      PG_NO_INTERNAL_BORDER = Wx::PG::PG_WINDOW_STYLES.new(16384)
+      
+      # A mask which can be used to filter (out) all styles.
+      # 
+      PG_WINDOW_STYLE_MASK = Wx::PG::PG_WINDOW_STYLES.new(32752)
+      
+    end # PG_WINDOW_STYLES
+    
+    # NOTE: {Wx::PG_EX_xxx} are extra window styles and must be set using SetExtraStyle() member function.
+    # 
+    # 
+    # 
+    # @wxrb_require USE_PROPGRID
+    class PG_EX_WINDOW_STYLES < Wx::Enum
+    
+      # Speeds up switching to {Wx::PG::PG_WINDOW_STYLES::PG_HIDE_CATEGORIES} mode.
+      # 
+      PG_EX_INIT_NOCAT = Wx::PG::PG_EX_WINDOW_STYLES.new(4096)
+      
+      # Extended window style that sets {Wx::PG::PropertyGridManager} tool bar to not use flat style.
+      # 
+      PG_EX_NO_FLAT_TOOLBAR = Wx::PG::PG_EX_WINDOW_STYLES.new(8192)
+      
+      # Shows alphabetic/categoric mode buttons on {Wx::PG::PropertyGridManager} tool bar.
+      # 
+      PG_EX_MODE_BUTTONS = Wx::PG::PG_EX_WINDOW_STYLES.new(32768)
+      
+      # Show property help strings as tool tips instead as text on the status bar.
+      # 
+      PG_EX_HELP_AS_TOOLTIPS = Wx::PG::PG_EX_WINDOW_STYLES.new(65536)
+      
+      # Allows relying on native double-buffering.
+      # 
+      PG_EX_NATIVE_DOUBLE_BUFFERING = Wx::PG::PG_EX_WINDOW_STYLES.new(524288)
+      
+      # Set this style to let user have ability to set values of properties to unspecified state.
+      # 
+      PG_EX_AUTO_UNSPECIFIED_VALUES = Wx::PG::PG_EX_WINDOW_STYLES.new(2097152)
+      
+      # If this style is used, built-in attributes (such as {Wx::PG::PG_FLOAT_PRECISION} and {Wx::PG::PG_STRING_PASSWORD}) are not stored into property's attribute storage (thus they are not readable).
+      # 
+      PG_EX_WRITEONLY_BUILTIN_ATTRIBUTES = Wx::PG::PG_EX_WINDOW_STYLES.new(4194304)
+      
+      # Hides page selection buttons from {Wx::PG::PropertyGridManager} tool bar.
+      # 
+      PG_EX_HIDE_PAGE_BUTTONS = Wx::PG::PG_EX_WINDOW_STYLES.new(16777216)
+      
+      # Allows multiple properties to be selected by user (by pressing SHIFT when clicking on a property, or by dragging with left mouse button down).
+      # 
+      PG_EX_MULTIPLE_SELECTION = Wx::PG::PG_EX_WINDOW_STYLES.new(33554432)
+      
+      # This enables top-level window tracking which allows {Wx::PG::PropertyGrid} to notify the application of last-minute property value changes by user.
+      # 
+      PG_EX_ENABLE_TLP_TRACKING = Wx::PG::PG_EX_WINDOW_STYLES.new(67108864)
+      
+      # Don't show divider above {Wx::PG::PropertyGridManager} toolbar (WXMSW only).
+      # 
+      PG_EX_NO_TOOLBAR_DIVIDER = Wx::PG::PG_EX_WINDOW_STYLES.new(134217728)
+      
+      # Show a separator below the {Wx::PG::PropertyGridManager} toolbar.
+      # 
+      PG_EX_TOOLBAR_SEPARATOR = Wx::PG::PG_EX_WINDOW_STYLES.new(268435456)
+      
+      # Allows taking focus on the entire area (on canvas) even if {Wx::PG::PropertyGrid} is not a standalone control.
+      # 
+      PG_EX_ALWAYS_ALLOW_FOCUS = Wx::PG::PG_EX_WINDOW_STYLES.new(1048576)
+      
+      # A mask which can be used to filter (out) all extra styles applicable to {Wx::PG::PropertyGrid}.
+      # 
+      PG_EX_WINDOW_PG_STYLE_MASK = Wx::PG::PG_EX_WINDOW_STYLES.new(108597248)
+      
+      # A mask which can be used to filter (out) all extra styles applicable to {Wx::PG::PropertyGridManager}.
+      # 
+      PG_EX_WINDOW_PGMAN_STYLE_MASK = Wx::PG::PG_EX_WINDOW_STYLES.new(419471360)
+      
+      # A mask which can be used to filter (out) all extra styles.
+      # 
+      PG_EX_WINDOW_STYLE_MASK = Wx::PG::PG_EX_WINDOW_STYLES.new(528068608)
+      
+    end # PG_EX_WINDOW_STYLES
+    
+    # Combines various styles.
+    # 
+    PG_DEFAULT_STYLE = 0
+    
+    # Combines various styles.
+    # 
+    PGMAN_DEFAULT_STYLE = 0
+    
+    # {Wx::PG::PropertyGrid} Validation Failure behaviour Flags
+    # 
+    # ## wxPropertyGrid Validation Failure behaviour Flags
+    # 
+    # @wxrb_require USE_PROPGRID
+    class PGVFBFlags < Wx::Enum
+    
+      # 
+      # 
+      Null = Wx::PG::PGVFBFlags.new(0)
+      
+      # Prevents user from leaving property unless value is valid.
+      # 
+      StayInProperty = Wx::PG::PGVFBFlags.new(1)
+      
+      # Calls {bell} on validation failure.
+      # 
+      Beep = Wx::PG::PGVFBFlags.new(2)
+      
+      # Cell with invalid value will be marked (with red colour).
+      # 
+      MarkCell = Wx::PG::PGVFBFlags.new(4)
+      
+      # Display a text message explaining the situation.
+      # 
+      ShowMessage = Wx::PG::PGVFBFlags.new(8)
+      
+      # Similar to SHOW_MESSAGE, except always displays the message using {Wx::MessageBox}.
+      # 
+      ShowMessageBox = Wx::PG::PGVFBFlags.new(16)
+      
+      # Similar to SHOW_MESSAGE, except always displays the message on the status bar (when present - you can reimplement {Wx::PG::PropertyGrid#get_status_bar} in a derived class to specify this yourself).
+      # 
+      ShowMessageOnStatusBar = Wx::PG::PGVFBFlags.new(32)
+      
+      # Defaults.
+      # 
+      Default = Wx::PG::PGVFBFlags.new(20)
+      
+      # 
+      # 
+      Undefined = Wx::PG::PGVFBFlags.new(64)
+      
+    end # PGVFBFlags
+    
+    # 
+    # 
+    # ## wxPropertyGrid Action Identifiers
+    # These are used with {Wx::PG::PropertyGrid#add_action_trigger} and {Wx::PG::PropertyGrid#clear_action_triggers}.
+    # 
+    # @wxrb_require USE_PROPGRID
+    class PGKeyboardAction < Wx::Enum
+    
+      # 
+      # 
+      Invalid = Wx::PG::PGKeyboardAction.new(0)
+      
+      # Select the next property.
+      # 
+      NextProperty = Wx::PG::PGKeyboardAction.new(1)
+      
+      # Select the previous property.
+      # 
+      PrevProperty = Wx::PG::PGKeyboardAction.new(2)
+      
+      # Expand the selected property, if it has child items.
+      # 
+      ExpandProperty = Wx::PG::PGKeyboardAction.new(3)
+      
+      # Collapse the selected property, if it has child items.
+      # 
+      CollapseProperty = Wx::PG::PGKeyboardAction.new(4)
+      
+      # Cancel and undo any editing done in the currently active property editor.
+      # 
+      CancelEdit = Wx::PG::PGKeyboardAction.new(5)
+      
+      # Move focus to the editor control of the currently selected property.
+      # 
+      Edit = Wx::PG::PGKeyboardAction.new(6)
+      
+      # Causes editor's button (if any) to be pressed.
+      # 
+      PressButton = Wx::PG::PGKeyboardAction.new(7)
+      
+    end # PGKeyboardAction
+    
+    # 
+    # 
+    EVT_PG_SELECTED = 10373
+    
+    # 
+    # 
+    EVT_PG_CHANGING = 10374
+    
+    # 
+    # 
+    EVT_PG_CHANGED = 10375
+    
+    # 
+    # 
+    EVT_PG_HIGHLIGHTED = 10376
+    
+    # 
+    # 
+    EVT_PG_RIGHT_CLICK = 10377
+    
+    # 
+    # 
+    EVT_PG_PAGE_CHANGED = 10378
+    
+    # 
+    # 
+    EVT_PG_ITEM_COLLAPSED = 10380
+    
+    # 
+    # 
+    EVT_PG_ITEM_EXPANDED = 10379
+    
+    # 
+    # 
+    EVT_PG_DOUBLE_CLICK = 10381
+    
+    # 
+    # 
+    EVT_PG_LABEL_EDIT_BEGIN = 10382
+    
+    # 
+    # 
+    EVT_PG_LABEL_EDIT_ENDING = 10383
+    
+    # 
+    # 
+    EVT_PG_COL_BEGIN_DRAG = 10384
+    
+    # 
+    # 
+    EVT_PG_COL_DRAGGING = 10385
+    
+    # 
+    # 
+    EVT_PG_COL_END_DRAG = 10386
+    
+    # Used to convey validation information to and from functions that actually perform validation.
+    # 
+    # Mostly used in custom property classes.
+    # 
+    # 
+    # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+    # @wxrb_require USE_PROPGRID
+    class PGValidationInfo < ::Object
+    
+      # 
+      # 
+      # Returns failure behaviour which is a combination of wxPropertyGrid Validation Failure behaviour Flags.
+      # @return [Wx::PGVFBFlags]
+      def get_failure_behavior; end
+      alias_method :failure_behavior, :get_failure_behavior
+      
+      # Returns current failure message.
+      # @return [Wx::String]
+      def get_failure_message; end
+      alias_method :failure_message, :get_failure_message
+      
+      # Returns reference to pending value.
+      # @return [Wx::Variant]
+      def get_value; end
+      alias_method :value, :get_value
+      
+      # Set validation failure behaviour.
+      # @param failureBehavior [Wx::PGVFBFlags]  Mixture of wxPropertyGrid Validation Failure behaviour Flags.
+      # @return [void]
+      def set_failure_behavior(failureBehavior) end
+      alias_method :failure_behavior=, :set_failure_behavior
+      
+      # Set current failure message.
+      # @param message [String] 
+      # @return [void]
+      def set_failure_message(message) end
+      alias_method :failure_message=, :set_failure_message
+      
+    end # PGValidationInfo
+    
+
+  end
+
+end