Skip to content

Missing documentation for Canvas API (FillRect, DrawLine, etc.) #110

Description

@elidanngos

Hello, and thank you for providing delphifmx .

While working with the drawing APIs (specifically TCanvas and related methods such as FillRect, DrawLine, Fill, Stroke, etc.), I noticed that there is no official documentation describing: the exact method signatures exposed by the Python wrapper which FMX overloads are supported which parameters are accepted or ignored differences between the Delphi FMX API and the delphifmx Python API platform‑specific limitations

Because FMX in Delphi exposes multiple overloaded versions of these methods, and the Python wrapper only supports a subset of them, it is currently difficult to determine the correct usage without trial‑and‑error. This leads to runtime errors such as:

"FillRect" called with invalid arguments.
Expected and actual arguments are incompatible.

It would be extremely helpful if the project could provide:

  • A dedicated section in the documentation for the Canvas API, listing all supported methods and their exact Python signatures.
  • Examples of basic drawing operations, such as filling rectangles, drawing lines, clearing the background, etc.
  • Clarification on unsupported FMX overloads, so users know what to expect.
  • A minimal working example demonstrating the correct use of PaintBox.OnPaint and TCanvas methods.

This would greatly improve the developer experience and reduce confusion when porting FMX code from Delphi to Python.

Thank you for your work on this project, and for considering this request.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions