wxruby3 0.9.0.pre.rc.2-x64-mingw-ucrt → 0.9.0-x64-mingw-ucrt

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

@@ -10,100 +10,75 @@ module Wx::PG
   # You will need to create a new property editor class, override CreateControls, and have it return {Wx::PG::PGMultiButton} instance in Wx::PGWindowList#set_secondary.
   # For instance, here we add three buttons to a TextCtrl editor:
   # 
-  # ```
-  #   #include <wx/propgrid/editors.h>
-  #   
-  #   class wxSampleMultiButtonEditor : public wxPGTextCtrlEditor
-  #   {
-  #       wxDECLARE_DYNAMIC_CLASS(wxSampleMultiButtonEditor);
-  #   
-  #   public:
-  #       wxSampleMultiButtonEditor() {}
-  #       virtual ~wxSampleMultiButtonEditor() {}
-  #   
-  #       virtual wxString GetName() const { return "SampleMultiButtonEditor"; }
-  #   
-  #       virtual wxPGWindowList CreateControls( wxPropertyGrid* propGrid,
-  #                                              wxPGProperty* property,
-  #                                              const wxPoint& pos,
-  #                                              const wxSize& sz ) const;
-  #       virtual bool OnEvent( wxPropertyGrid* propGrid,
-  #                             wxPGProperty* property,
-  #                             wxWindow* ctrl,
-  #                             wxEvent& event ) const;
-  #   };
-  #   
-  #   wxIMPLEMENT_DYNAMIC_CLASS(wxSampleMultiButtonEditor, wxPGTextCtrlEditor);
-  #   
-  #   wxPGWindowList wxSampleMultiButtonEditor::CreateControls( wxPropertyGrid* propGrid,
-  #                                                             wxPGProperty* property,
-  #                                                             const wxPoint& pos,
-  #                                                             const wxSize& sz ) const
-  #   {
-  #       // Create and populate buttons-subwindow
-  #       wxPGMultiButton* buttons = new wxPGMultiButton( propGrid, sz );
-  #   
-  #       // Add two regular buttons
-  #       buttons->Add( "..." );
-  #       buttons->Add( "A" );
-  #       // Add a bitmap button
-  #       buttons->Add( wxArtProvider::GetBitmap(wxART_FOLDER) );
-  #   
-  #       // Create the 'primary' editor control (textctrl in this case)
-  #       wxPGWindowList wndList = wxPGTextCtrlEditor::CreateControls
-  #                                ( propGrid, property, pos,
-  #                                  buttons->GetPrimarySize() );
+  # ```ruby
+  #   class WxSampleMultiButtonEditor < Wx::PG::PGTextCtrlEditor
+  # 
+  #     def initialize
+  #       super
+  #     end
+  # 
+  #     def create_controls(propGrid, property, pos, sz)
+  #       # Create and populate buttons-subwindow
+  #       buttons = Wx::PG::PGMultiButton.new(propGrid, sz)
   #   
-  #       // Finally, move buttons-subwindow to correct position and make sure
-  #       // returned wxPGWindowList contains our custom button list.
-  #       buttons->Finalize(propGrid, pos);
+  #       # Add two regular buttons
+  #       buttons.add('...')
+  #       buttons.add('A')
+  #       # Add a bitmap button
+  #       buttons.add(Wx::ArtProvider::get_bitmap(Wx::ART_FOLDER))
   #   
-  #       wndList.SetSecondary( buttons );
-  #       return wndList;
-  #   }
+  #       # Create the 'primary' editor control (textctrl in this case)
+  #       primary, _ = super(propGrid, property, pos, buttons.primary_size)
   #   
-  #   bool wxSampleMultiButtonEditor::OnEvent( wxPropertyGrid* propGrid,
-  #                                            wxPGProperty* property,
-  #                                            wxWindow* ctrl,
-  #                                            wxEvent& event ) const
-  #   {
-  #       if ( event.GetEventType() == wxEVT_BUTTON )
-  #       {
-  #           wxPGMultiButton* buttons = (wxPGMultiButton*) propGrid->GetEditorControlSecondary();
+  #       # Finally, move buttons-subwindow to correct position and make sure
+  #       # returned Wx::PG::PGWindowList contains our custom button list.
+  #       buttons.finalize(propGrid, pos)
   #   
-  #           if ( event.GetId() == buttons->GetButtonId(0) )
-  #           {
-  #               // Do something when the first button is pressed
-  #               // Return true if the action modified the value in editor.
-  #               ...
-  #           }
-  #           if ( event.GetId() == buttons->GetButtonId(1) )
-  #           {
-  #               // Do something when the second button is pressed
-  #               ...
-  #           }
-  #           if ( event.GetId() == buttons->GetButtonId(2) )
-  #           {
-  #               // Do something when the third button is pressed
-  #               ...
-  #           }
-  #       }
-  #       return wxPGTextCtrlEditor::OnEvent(propGrid, property, ctrl, event);
-  #   }
+  #       [primary, buttons]
+  #     end
+  # 
+  #     def on_event(propGrid, property, ctrl, event)
+  #       if event.event_type == Wx::EVT_BUTTON
+  #         buttons = propGrid.get_editor_control_secondary
+  #     
+  #         if event.id == buttons.button_id(0)
+  #     
+  #           # Do something when the first button is pressed
+  #           Wx::log_info('First button pressed')
+  #           return false # Return false since value did not change
+  #         end
+  #         if event.id == buttons.get_button_id(1)
+  #     
+  #           # Do something when the second button is pressed
+  #           Wx.message_box('Second button pressed')
+  #           return false # Return false since value did not change
+  #         end
+  #         if event.id == buttons.button_id(2)
+  #           # Do something when the third button is pressed
+  #           Wx.message_box('Third button pressed')
+  #           return false # Return false since value did not change
+  #         end
+  #       end
+  #       super(propGrid, property, ctrl, event)
+  #     end
+  # 
+  #   end # class WxSampleMultiButtonEditor
   # ```
   # 
   # Further to use this editor, code like this can be used:
   # 
-  # ```
-  #   // Register editor class - needs only to be called once
-  #   wxPGEditor* multiButtonEditor = new wxSampleMultiButtonEditor();
-  #   wxPropertyGrid::RegisterEditorClass( multiButtonEditor );
-  #   
-  #   // Insert the property that will have multiple buttons
-  #   propGrid->Append( new wxLongStringProperty("MultipleButtons", wxPG_LABEL) );
-  #   
-  #   // Change property to use editor created in the previous code segment
-  #   propGrid->SetPropertyEditor( "MultipleButtons", multiButtonEditor );
+  # ```ruby
+  #   # Register editor class - needs only to be called once
+  #   @sampleMultiButtonEditor =
+  #     Wx::PG::PropertyGrid.register_editor_class(WxSampleMultiButtonEditor.new)
+  # 
+  #   # ...
+  # 
+  #   # Insert the property that will have multiple buttons
+  #   propGrid.append(Wx::PG::LongStringProperty.new("MultipleButtons", Wx::PG::PG_LABEL))
+  # 
+  #   # Change property to use editor created in the previous code segment
+  #   propGrid.set_property_editor("MultipleButtons", @sampleMultiButtonEditor)            
   # ```
   # 
   # === 
@@ -113,9 +88,9 @@ module Wx::PG
   class PGMultiButton < Window
   
     # Constructor.
-    # @param pg [Wx::PropertyGrid] 
+    # @param pg [Wx::PG::PropertyGrid] 
     # @param sz [Array(Integer, Integer), Wx::Size] 
-    # @return [PGMultiButton]
+    # @return [Wx::PG::PGMultiButton]
     def initialize(pg, sz) end
     
     # @overload add(label, id=-2)
@@ -131,7 +106,7 @@ module Wx::PG
     def add(*args) end
     
     # Call this in CreateControls() of your custom editor class after all buttons have been added.
-    # @param propGrid [Wx::PropertyGrid]  {Wx::PG::PropertyGrid} given in CreateControls().
+    # @param propGrid [Wx::PG::PropertyGrid]  {Wx::PG::PropertyGrid} given in CreateControls().
     # @param pos [Array(Integer, Integer), Wx::Point]  {Wx::Point} given in CreateControls().
     # @return [void]
     def finalize(propGrid, pos) end