Menu

#2337 ScintillaDoc: is SCI_SETSELFORE obsolete?

Documentation
closed-rejected
nobody
5
2022-07-09
2022-06-24
DV
No

There is a message SCI_SETSELFORE that sets the foreground color of the active text. This color is not applied to the inactive text.
There is a message SCI_SETELEMENTCOLOUR that sets a color of any element.
Because of that, should we consider SCI_SETSELFORE obsolete?
The SCI_SETSELFORE documentation mentiones "The element APIs are now preferred as they handle translucency + layering and cooperation with defaults better", and there are two problems with this text:
1. It does not explicitly mark SCI_SETSELFORE as obsolete;
2. It does not explicitly mention the name of the SCI_SETELEMENTCOLOUR message.
Action item: please update the ScintillaDoc by adding an explicit text for SCI_SETSELFORE such as "SCI_SETSELFORE does not set the inactive text foreground color and is obsolete, please use SCI_SETELEMENTCOLOUR instead". Even for more clarity, for SCI_SETELEMENTCOLOUR the documentation may say: "this message replaces the obsolete SCI_SETSELFORE".

Discussion

  • Neil Hodgson

    Neil Hodgson - 2022-06-24
    • labels: --> scintilla, documentation
    • status: open --> open-rejected
     
  • Neil Hodgson

    Neil Hodgson - 2022-06-24

    1) SCI_SETSELFORE is not obsolete.
    2) There is a link to the 'element APIs' which include SCI_SETELEMENTCOLOUR.

    SCI_SETSELFORE is currently discouraged which is marked by orange strike out. The 'discouraged' state is documented in the "Deprecated and discouraged messages and notifications" section. SCI_SETSELFORE is immediately preceded by SC_ELEMENT_SELECTION_TEXT.

     
  • Neil Hodgson

    Neil Hodgson - 2022-06-24

    SCI_SETSELFORE could set SC_ELEMENT_SELECTION_INACTIVE_TEXT and that may be more compatible with 4.x for applications that currently call it.

     
  • Neil Hodgson

    Neil Hodgson - 2022-07-09
    • status: open-rejected --> closed-rejected
     

Log in to post a comment.