wxruby3-shapes 0.9.0.pre.beta.3

data/samples/sample2/sample_shape.rb

@@ -0,0 +1,108 @@
+# Wx::SF - Sample2 SampleShape class
+# Copyright (c) M.J.N. Corino, The Netherlands
+
+require 'wx/shapes'
+
+class SampleShape < Wx::SF::RectShape
+
+  def initialize
+    super
+  end
+
+  # override required wxSF virtual functions
+	def on_left_click(pos)
+    SFSample2Frame.log(SFSample2Frame::LOGTYPE::MouseEvent, "Called handler: 'on_left_click', Shape ID: #{get_id}, Position: #{pos}\n")
+
+    # call original handler if required
+    super
+  end
+	def on_right_click(pos)
+    SFSample2Frame.log(SFSample2Frame::LOGTYPE::MouseEvent, "Called handler: 'on_right_click', Shape ID: #{get_id}, Position: #{pos}\n")
+
+    # call original handler if required
+    super
+  end
+	def on_left_double_click(pos)
+    SFSample2Frame.log(SFSample2Frame::LOGTYPE::MouseEvent, "Called handler: 'on_left_double_click', Shape ID: #{get_id}, Position: #{pos}\n")
+
+    # call original handler if required
+    super
+  end
+	def on_right_double_click(pos)
+    SFSample2Frame.log(SFSample2Frame::LOGTYPE::MouseEvent, "Called handler: 'on_right_double_click', Shape ID: #{get_id}, Position: #{pos}\n")
+
+    # call original handler if required
+    super
+  end
+
+	def on_begin_drag(pos)
+    SFSample2Frame.log(SFSample2Frame::LOGTYPE::MouseEvent, "Called handler: 'on_begin_drag', Shape ID: #{get_id}, Position: #{pos}\n")
+
+    # call original handler if required
+    super
+  end
+	def on_dragging(pos)
+    SFSample2Frame.log(SFSample2Frame::LOGTYPE::MouseEvent, "Called handler: 'on_dragging', Shape ID: #{get_id}, Position: #{pos}\n")
+
+    # call original handler if required
+    super
+  end
+	def on_end_drag(pos)
+    SFSample2Frame.log(SFSample2Frame::LOGTYPE::MouseEvent, "Called handler: 'on_end_drag', Shape ID: #{get_id}, Position: #{pos}\n")
+
+    # call original handler if required
+    super
+  end
+
+	def on_begin_handle(handle)
+    SFSample2Frame.log(SFSample2Frame::LOGTYPE::HandleEvent, "Called handler: 'on_begin_handle()', Shape ID: #{get_id}, Handle type: #{handle.type}\n")
+
+    # call original handler if required
+    super
+  end
+	def on_handle(handle)
+    SFSample2Frame.log(SFSample2Frame::LOGTYPE::HandleEvent, "Called handler: 'on_handle()', Shape ID: #{get_id}, Handle type: #{handle.type}\n")
+
+    # call original handler if required
+    super
+  end
+	def on_end_handle(handle)
+    SFSample2Frame.log(SFSample2Frame::LOGTYPE::HandleEvent, "Called handler: 'on_end_handle()', Shape ID: #{get_id}, Handle type: #{handle.type}\n")
+
+    # call original handler if required
+    super
+  end
+
+	def on_mouse_enter(pos)
+    SFSample2Frame.log(SFSample2Frame::LOGTYPE::MouseEvent, "Called handler: 'on_mouse_enter', Shape ID: #{get_id}, Position: #{pos}\n")
+
+    # call original handler if required
+    super
+  end
+	def on_mouse_over(pos)
+    SFSample2Frame.log(SFSample2Frame::LOGTYPE::MouseEvent, "Called handler: 'on_mouse_over', Shape ID: #{get_id}, Position: #{pos}\n")
+
+    # call original handler if required
+    super
+  end
+	def on_mouse_leave(pos)
+    SFSample2Frame.log(SFSample2Frame::LOGTYPE::MouseEvent, "Called handler: 'on_mouse_leave', Shape ID: #{get_id}, Position: #{pos}\n")
+
+    # call original handler if required
+    super
+  end
+
+  def on_key(key)
+    SFSample2Frame.log(SFSample2Frame::LOGTYPE::KeyEvent, "Called handler: 'on_key()', Shape ID: #{get_id}, Key code: #{key}\n")
+
+    # call original handler if required
+    super
+  end
+
+	def on_child_dropped(pos, child)
+    SFSample2Frame.log(SFSample2Frame::LOGTYPE::ChildDropEvent, "Called handler: 'on_child_dropped()', Parent shape ID: #{get_id}, Child shape ID: #{child.get_id}\n")
+
+    # call original handler if required
+    super
+  end
+end

data/samples/sample3/art/sample.xpm

@@ -0,0 +1,251 @@
+/* XPM */
+static char * sample_xpm[] = {
+"32 32 216 2",
+"  	c None",
+". 	c #872C2C",
+"+ 	c #A52827",
+"@ 	c #A42828",
+"# 	c #553131",
+"$ 	c #7D2D2D",
+"% 	c #3D3232",
+"& 	c #535331",
+"* 	c #AEAE26",
+"= 	c #85852C",
+"- 	c #ACAC26",
+"; 	c #88882C",
+"> 	c #9B2929",
+", 	c #A92626",
+"' 	c #F10D0C",
+") 	c #B32424",
+"! 	c #D91919",
+"~ 	c #A52727",
+"{ 	c #E51414",
+"] 	c #DC1817",
+"^ 	c #9F2828",
+"/ 	c #A5A527",
+"( 	c #F2F20B",
+"_ 	c #FFFF00",
+": 	c #F1F10C",
+"< 	c #AEAE25",
+"[ 	c #E7E712",
+"} 	c #BEBE22",
+"| 	c #999929",
+"1 	c #DE1716",
+"2 	c #A82626",
+"3 	c #EF0E0D",
+"4 	c #CA1E1E",
+"5 	c #C42020",
+"6 	c #EC1010",
+"7 	c #9E2828",
+"8 	c #B12525",
+"9 	c #E91211",
+"0 	c #922A2A",
+"a 	c #A8A827",
+"b 	c #EFEF0D",
+"c 	c #C5C520",
+"d 	c #FBFB03",
+"e 	c #A6A627",
+"f 	c #FAFA04",
+"g 	c #CACA1E",
+"h 	c #DDDD18",
+"i 	c #F8F806",
+"j 	c #B8B823",
+"k 	c #E3E315",
+"l 	c #9E2929",
+"m 	c #D01D1D",
+"n 	c #B72423",
+"o 	c #AD2625",
+"p 	c #DD1817",
+"q 	c #B22525",
+"r 	c #D71A1A",
+"s 	c #EBEB10",
+"t 	c #B0B025",
+"u 	c #C0C021",
+"v 	c #E6E613",
+"w 	c #97972A",
+"x 	c #A22828",
+"y 	c #BB2323",
+"z 	c #B82424",
+"A 	c #4A3232",
+"B 	c #842D2D",
+"C 	c #912B2B",
+"D 	c #5B3131",
+"E 	c #70702F",
+"F 	c #C6C620",
+"G 	c #8E8E2B",
+"H 	c #9A9A29",
+"I 	c #484832",
+"J 	c #A4A428",
+"K 	c #9D2828",
+"L 	c #E61211",
+"M 	c #E51212",
+"N 	c #DF1615",
+"O 	c #D21B1A",
+"P 	c #423232",
+"Q 	c #515131",
+"R 	c #E4E412",
+"S 	c #F3F307",
+"T 	c #E2E213",
+"U 	c #BEBE20",
+"V 	c #ECEC0C",
+"W 	c #B1B124",
+"X 	c #999928",
+"Y 	c #CF1D1D",
+"Z 	c #CD1E1D",
+"` 	c #D21C1C",
+" .	c #A42727",
+"..	c #ED0F0F",
+"+.	c #7E2D2D",
+"@.	c #92922B",
+"#.	c #FDFD01",
+"$.	c #D1D11C",
+"%.	c #E5E513",
+"&.	c #643030",
+"*.	c #E61313",
+"=.	c #EE0F0E",
+"-.	c #A92726",
+";.	c #C1C121",
+">.	c #ADAD25",
+",.	c #EEEE0E",
+"'.	c #5C5C31",
+").	c #F00D0C",
+"!.	c #AA2726",
+"~.	c #AF2525",
+"{.	c #EA1110",
+"].	c #32365A",
+"^.	c #333440",
+"/.	c #E2E215",
+"(.	c #F0F00D",
+"_.	c #C4C420",
+":.	c #F5F508",
+"<.	c #BCBC22",
+"[.	c #FCFC02",
+"}.	c #8C8C2B",
+"|.	c #B92323",
+"1.	c #E51413",
+"2.	c #633030",
+"3.	c #313A74",
+"4.	c #2D43AE",
+"5.	c #2E40A2",
+"6.	c #313975",
+"7.	c #77772E",
+"8.	c #F7F706",
+"9.	c #CBCB1E",
+"0.	c #BABA23",
+"a.	c #D81919",
+"b.	c #A62727",
+"c.	c #D41B1B",
+"d.	c #C91F1E",
+"e.	c #8F2B2B",
+"f.	c #323553",
+"g.	c #2C45BA",
+"h.	c #284CE0",
+"i.	c #2A4AD5",
+"j.	c #2C46C0",
+"k.	c #A3A328",
+"l.	c #DEDE17",
+"m.	c #772E2E",
+"n.	c #EC100F",
+"o.	c #AB2626",
+"p.	c #B12524",
+"q.	c #2B47C8",
+"r.	c #2D43AF",
+"s.	c #2453FF",
+"t.	c #2552FA",
+"u.	c #2D44B6",
+"v.	c #2C45BE",
+"w.	c #BEBE21",
+"x.	c #BFBF22",
+"y.	c #B2B224",
+"z.	c #6B2F2F",
+"A.	c #C6201F",
+"B.	c #2F409F",
+"C.	c #2551F8",
+"D.	c #2C44B9",
+"E.	c #2452FC",
+"F.	c #2F3E92",
+"G.	c #585831",
+"H.	c #8E8E2A",
+"I.	c #79792D",
+"J.	c #5C3030",
+"K.	c #333333",
+"L.	c #313971",
+"M.	c #2551F5",
+"N.	c #2A49D0",
+"O.	c #284EE6",
+"P.	c #294BD9",
+"Q.	c #294CDD",
+"R.	c #2650F1",
+"S.	c #323761",
+"T.	c #606030",
+"U.	c #294CDE",
+"V.	c #2D42AD",
+"W.	c #2D43B3",
+"X.	c #2A4AD6",
+"Y.	c #2C45BD",
+"Z.	c #303B7C",
+"`.	c #2650F0",
+" +	c #2650F3",
+".+	c #2B46C3",
+"++	c #284CDE",
+"@+	c #2A49D1",
+"#+	c #264FED",
+"$+	c #31396F",
+"%+	c #303D90",
+"&+	c #2B47C6",
+"*+	c #31386B",
+"=+	c #2E41A7",
+"-+	c #313A77",
+";+	c #303C86",
+">+	c #2551F7",
+",+	c #2D43B1",
+"'+	c #2E41A6",
+")+	c #2552FB",
+"!+	c #2552F9",
+"~+	c #2552F8",
+"{+	c #323765",
+"]+	c #2B48CB",
+"^+	c #2A49CF",
+"/+	c #274EE7",
+"(+	c #264FEE",
+"_+	c #2D42AE",
+":+	c #2650F2",
+"<+	c #294BDA",
+"[+	c #2C46C1",
+"}+	c #313A78",
+"|+	c #2D42AA",
+"1+	c #294BDC",
+"2+	c #2B48CA",
+"3+	c #2453FD",
+"                                                                ",
+"                                                                ",
+"                                                                ",
+"                                                                ",
+"                                                                ",
+"      . + + @ # $ + + + %             & * * * = & - * * ;       ",
+"    > , ' ' ) ! ~ { ' ] ^             / ( _ : < [ } _ _ < |     ",
+"    1 2 3 4 5 ' 6 7 3 8 9 0         a b c d e f _ g h i j k     ",
+"  l ' m n o ' ' ' p q ~ ' r         s _ < t b _ _ _ < u v _ w   ",
+"  x y z A z y y y y B C y y D     E F F G H F F F F } I c F J   ",
+"  K L L ^ M L L L L , N L O P     Q R S T U S S S S V W S S X   ",
+"    Y ' Z ` ' ' ' '  .' ..+.        @.#._ < _ _ _ _ $.%._ $.    ",
+"    &.*.=., ' ' ' ! 5 ' -.            } _ ;.( _ _ _ >._ ,.'.    ",
+"      C ).!.=.' ' ~.{.Z       ].^.      /.(._._ _ :.<.[.}.      ",
+"        |.` Z ' ' ~ 1.2.    3.4.5.6.    7.8.>._ _ 9.s 0.        ",
+"          a.b.' c.d.e.    f.g.h.i.j.      k.F ,._ < l.          ",
+"          m. .n.o.p.      q.r.s.t.u.v.      w.x.( y.E           ",
+"            z.A.$       B.C.D.s.s.r.E.F.    G.H._.I.            ",
+"              J.K.    L.M.N.O.s.s.P.Q.R.S.    K.T.              ",
+"              K.      U.s.V.s.s.s.E.W.s.X.                      ",
+"                    g.s.M.Y.s.s.s.s.W.E.s.V.                    ",
+"                  Z.`. +.+++ + + + +@+N. +#+$+                  ",
+"                  %+&+&+*+W.&+&+&+&+=+-+&+&+;+                  ",
+"                  6.E.>+,+'+)+s.s.!+=+r.E.~+{+                  ",
+"                    ]+^+/+(+,+s.s._+:+Q.<+[+                    ",
+"                    }+|+s.s.1+q.2+Q.s.3+=+{+                    ",
+"                      6._+_+_+$+$+_+_+_+*+                      ",
+"                                                                ",
+"                                                                ",
+"                                                                ",
+"                                                                ",
+"                                                                "};

data/samples/sample3/sample.rb

@@ -0,0 +1,281 @@
+# Wx::SF - Sample3
+# Copyright (c) M.J.N. Corino, The Netherlands
+
+require 'wx/shapes'
+
+class StarShape < Wx::SF::PolygonShape
+
+  # star shape vertices
+  STAR = [Wx::RealPoint.new(0, -50), Wx::RealPoint.new(15, -10),
+          Wx::RealPoint.new(50, -10), Wx::RealPoint.new(22, 10),
+          Wx::RealPoint.new(40, 50), Wx::RealPoint.new(0, 20),
+          Wx::RealPoint.new(-40, 50), Wx::RealPoint.new(-22, 10),
+          Wx::RealPoint.new(-50, -10), Wx::RealPoint.new(-15, -10)]
+
+  # regular property
+  property :description
+  # component shape property (this specifies that this item should be serialized as a property of this class and
+  # not from any reference elsewhere like it's parents child shapes list)
+  component :title
+  # disable serialization of polygon vertices for this PolygonShape derivative,
+  # because they are always set in constructor for this class
+  excludes :vertices
+
+  # @overload initialize()
+  #   Default constructor.
+  # @overload initialize(pos, size, diagram)
+  #   User constructor.
+  #   @param [Wx::RealPoint] pos Initial position
+  #   @param [Wx::SF::Diagram] diagram parent diagram
+  def initialize(*args)
+    if args.empty?
+      super()
+      set_vertices(STAR)
+    else
+      pos, diagram = args
+      super(STAR, pos, diagram)
+    end
+    init
+  end
+
+  protected
+
+  def get_description
+    @description
+  end
+
+  def set_description(desc)
+    @description = desc
+  end
+
+  def get_title
+    @text
+  end
+
+  private
+
+  def set_title(txt)
+    @text = txt
+  end
+
+  def init
+    # initialize custom data members...
+    @description = "Insert some shape's description text here..."
+
+    # polygon-based shapes can be connected either to the vertices or to the
+    # nearest border point (default value is true).
+    set_connect_to_vertex(false)
+
+    # set accepted connections for the new shape
+    accept_connection(Wx::SF::ACCEPT_ALL)
+    accept_src_neighbour(StarShape)
+    accept_trg_neighbour(StarShape)
+
+    # create associated shape(s)
+    @text = Wx::SF::EditTextShape.new
+    # set some properties
+    if @text
+      # set text
+      @text.set_text('Hello!')
+      # set alignment
+      @text.set_v_align(Wx::SF::Shape::VALIGN::MIDDLE)
+      @text.set_h_align(Wx::SF::Shape::HALIGN::CENTER)
+
+      # set required shape style(s)
+      @text.set_style(STYLE::ALWAYS_INSIDE | STYLE::HOVERING | STYLE::PROCESS_DEL | STYLE::PROPAGATE_DRAGGING | STYLE::PROPAGATE_SELECTION | STYLE::PROPAGATE_INTERACTIVE_CONNECTION)
+      # you can also force displaying of the shapes handles even if the interactive
+      # size change is not allowed:
+      #@text.add_style(STYLE::SHOW_HANDLES)
+
+      # we use #set_parent_shape and not #add_child_shape as we do not want it checked against the acceptance list
+      # (which is empty and we want to keep it like  that) and we already know it's not yet on the diagram so does
+      # not need to be removed as toplevel shape
+      @text.set_parent_shape(self)
+      # component will/should be added as child shape but will not be serialized as such
+      # instead the 'component :title' declaration above makes sure it will be serialized
+      # as a dedicated property of instances of this class
+
+    end
+  end
+
+end
+
+class SFSample3Frame < Wx::Frame
+
+  module ID
+    MenuQuit = 1000
+    MenuOpen = 1001
+    MenuSave = 1002
+    MenuAbout = 1003
+  end
+
+  def initialize(title)
+    super(nil, Wx::StandardID::ID_ANY, title, size: [800,600])
+
+    self.icon = Wx::Icon(:sample)
+
+    if Wx.has_feature?(:USE_MENUS)
+      # create a menu bar
+      mbar = Wx::MenuBar.new
+      file_menu = Wx::Menu.new
+      file_menu.append(ID::MenuOpen, "&Open\tCtrl-O", 'Open diagram from XML file')
+      file_menu.append(ID::MenuSave, "&Save\tCtrl-S", 'Save diagram to XML file')
+      file_menu.append_separator
+      file_menu.append(ID::MenuQuit, "&Quit\tAlt-F4", "Quit the application")
+      mbar.append(file_menu, "&File")
+
+      help_menu = Wx::Menu.new
+      help_menu.append(ID::MenuAbout, "&About\tF1", "Show info about this application")
+      mbar.append(help_menu, "&Help")
+  
+      self.menu_bar = mbar
+
+      evt_menu(ID::MenuOpen, :on_open)
+      evt_menu(ID::MenuSave, :on_save)
+      evt_menu(ID::MenuQuit, :on_quit)
+      evt_menu(ID::MenuAbout, :on_about)
+    end # wxUSE_MENUS
+    @diagram = Wx::SF::Diagram.new
+    # set some diagram manager properties if necessary...
+    # set accepted shapes (accept only Wx::SF::RectShape)
+    @diagram.clear_accepted_shapes
+    @diagram.accept_shape(StarShape)
+    @diagram.accept_shape(Wx::SF::TextShape)
+    @diagram.accept_shape(Wx::SF::LineShape)
+
+    # create shape canvas and associate it with shape manager
+    @canvas = Wx::SF::ShapeCanvas.new(@diagram, self)
+    # set some shape canvas properties if necessary...
+	  @canvas.add_style(Wx::SF::ShapeCanvas::STYLE::GRID_SHOW)
+    @canvas.add_style(Wx::SF::ShapeCanvas::STYLE::GRID_USE)
+
+    evt_close :on_close
+
+    # connect (some) shape canvas events
+    @canvas.evt_left_down { |evt| self.on_left_click_canvas(evt) }
+    @canvas.evt_right_down { |evt| self.on_right_click_canvas(evt) }
+
+    # connect (some) shape events (for full list of available shape/shape canvas events see Wx::SF reference documentation).
+    @canvas.evt_sf_line_done { |evt| self.on_line_done(evt) }
+    @canvas.evt_sf_text_change { |evt| self.on_text_change(evt) }
+
+    if Wx.has_feature?(:USE_STATUSBAR)
+      # create a status bar with some information about the used wxWidgets version
+      create_status_bar(2)
+      set_status_text('Hello wxRuby ShapeFramework user!',0)
+      set_status_text("wxRuby #{Wx::WXRUBY_VERSION} #{Wx::PLATFORM} (wxWidgets #{Wx::WXWIDGETS_VERSION})", 1)
+    end # wxUSE_STATUSBAR
+
+    center
+  end
+
+  # Window event handlers
+
+  def on_close(_event)
+    destroy
+  end
+
+  def on_quit(_event)
+    destroy
+  end
+
+  def on_about(_event)
+    msg = "wxRuby ShapeFramework #{Wx::SF::VERSION}\n(wxRuby #{Wx::WXRUBY_VERSION} #{Wx::PLATFORM}; #{Wx::WXWIDGETS_VERSION})\n\n"
+
+    msg += "Welcome to wxRuby ShapeFramework Sample3 (c) Martin Corino, 2023\n"
+    msg += "(ported from wxSFShapeFramework original (c) Michal Bliznak, 2007 - 2013)\n\n"
+    msg += "Sample demonstrates basic Wx::SF functionality.\n"
+    msg += " - New custom 'composite' shape is created.\n"
+    msg += " - Shapes can be joined together by lines.\n\n"
+    msg += "Usage:\n"
+    msg += " - Left mouse click operates with inserted shapes\n"
+    msg += " - Right mouse click inserts a custom shape to the canvas or starts\n"
+    msg += "   interactive connection line's creation process\n"
+    msg += " - You can modify the star's text (double click it by the left mouse button)\n"
+    msg += " - DEL key removes selected shape\n"
+
+    Wx.message_box(msg, "wxRuby ShapeFramework Sample 3")
+  end
+
+  # event handlers for shape canvas
+
+  def on_left_click_canvas(event)
+    # HINT: perform your user actions here...
+
+    # ... and then process standard canvas operations
+    event.skip
+  end
+
+  def on_right_click_canvas(event)
+    # find out whether some shape has been clicked
+    if @canvas.get_shape_at_position(@canvas.dp2lp(event.get_position))
+      # start interactive connection creation
+      @canvas.start_interactive_connection(Wx::SF::LineShape, event.get_position)
+    else
+      # create new composite shape
+      @diagram.add_shape(s = StarShape.new, nil, event.get_position, Wx::SF::INITIALIZE, Wx::SF::DONT_SAVE_STATE)
+
+      # ... and process standard canvas operations
+      event.skip
+    end
+  end
+
+  # event handlers for shapes
+
+  # Event handler called when the interactive line creation process is finished.
+  # Alternatively you can override virtual function Wx::SF::ShapeCanvas#on_connection_finished.
+  def on_line_done(event)
+    # get new line shape (if created)
+    line = event.get_shape
+
+    if line.is_a?(Wx::SF::LineShape)
+      # assign target arrow to the line shape (also source arrow can be created)
+      line.set_trg_arrow(Wx::SF::SolidArrow)
+    end
+  end
+
+  # Event handler called when a text inside the star was changed.
+  # Alternatively you can override virtual function Wx::SF::ShapeCanvas#on_text_change.
+  def on_text_change(event)
+    # get changed text shape
+    text = event.get_shape
+	
+    if text.is_a?(Wx::SF::TextShape)
+		  # update the text shape and its parent(s)
+      text.update
+		  # display some info...
+      Wx.log_message("New text of the star with ID #{text.get_parent_shape.id.to_i} is : '#{event.text}'")
+    end
+  end
+
+  def on_open(_event)
+    Wx::FileDialog(self, 'Load diagram from file...', Dir.getwd, '', "JSON Files (*.json)|*.json", Wx::FD_OPEN) do |dlg|
+      if dlg.show_modal == Wx::ID_OK
+        File.open(dlg.get_path, 'r') do |f|
+          @canvas.set_diagram(Wx::SF::Serializable.deserialize(f))
+          @canvas.clear_canvas_history
+          @canvas.save_canvas_state
+        end
+        @diagram = @canvas.get_diagram
+        @canvas.refresh(false)
+      end
+    end
+  end
+
+  def on_save(_event)
+    Wx::FileDialog(self, 'Save diagram to XML...', Dir.getwd, '', 'JSON Files (*.json)|*.json', Wx::FD_SAVE) do |dlg|
+      if dlg.show_modal == Wx::ID_OK
+        # save diagram to file
+        File.open(dlg.get_path, 'w+') do |f|
+          @diagram.serialize(f, pretty: true)
+        end
+        Wx.message_box("The diagram has been saved to '#{dlg.get_path}'.", 'wxRuby ShapeFramework')
+      end
+    end
+  end
+
+end
+
+Wx::App.run do
+  SFSample3Frame.new('wxShapeFramework Sample 3').show
+end