DI_SINGLEBOX

main | Dialog API | Dialog items
The DI_SINGLEBOX dialog item describes a single line frame.
struct FarDialogItem
{
  int Type          = DI_SINGLEBOX
  int X1            = X1
  int Y1            = Y1
  int X2            = X2
  int Y2            = Y2
  int Focus         = 0
  int Selected      = 0
  DWORD Flags       = Flags
  int DefaultButton = 0
  char Data[512]    = Caption
};

Attention! Attention!

Flags

There are several flags applicable to the DI_SINGLEBOX control:
FlagDescription
DIF_SETCOLOR The low byte of Flags will be used as the frame color.
DIF_LEFTTEXT The caption of the frame will be left aligned.
DIF_SHOWAMPERSAND Show ampersand symbol in caption instead of using it for defining hotkeys.

Events

EventDescription
DN_DRAWDLGITEM This event is sent to the dialog callback function before the double line box is drawn.
DN_CTLCOLORDLGITEM Plugin should pass the color attributes of the frame when this event comes. Param2 parameter: 
LoWord LoByte - color of text in the caption
                (COL_WARNDIALOGBOXTITLE or
                 COL_DIALOGBOXTITLE)
LoWord HiByte - color of highlighted text in the caption
                (COL_WARNDIALOGHIGHLIGHTBOXTITLE or
                 COL_DIALOGHIGHLIGHTBOXTITLE)
HiWord LoByte - color of the frame lines
                (COL_WARNDIALOGBOX or COL_DIALOGBOX)
HiWord HiByte - 0 (not used)
DN_HOTKEY Hotkey was pressed (Alt-<letter>).
DN_MOUSECLICK This event comes after the user has clicked one of the dialog items or outside the dialog with the mouse button.

Remarks

  1. If this item is the first in the dialog items array, its caption is copied into the FAR console window title.
  2. When X1==X2 or Y1==Y2, a line (vertical or horizontal) will be drawn instead of a frame.
See also:
DI_DOUBLEBOX, FarDialogItem