summaryrefslogtreecommitdiff
path: root/plugins/ExternalAPI/delphi/m_msg_buttonsbar.inc
blob: e93e5cb5bd432fef2593ad020c2e0906739bde43 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
{$IFNDEF M_MSG_BUTTONSBAR}
{$DEFINE M_MSG_BUTTONSBAR}

//////////////////////////////////////////////////////////////////////////
// Services
//
//////////////////////////////////////////////////////////////////////////
// Adding a button
//
// wParam  = 0
// lParam  = (BBButton *) &description
const
  MS_BB_ADDBUTTON:PAnsiChar = 'TabSRMM/ButtonsBar/AddButton';

//////////////////////////////////////////////////////////////////////////
// Remove button
//
// wParam = 0 
// lParam  = (BBButton *) &description, only button ID and ModuleName used
  MS_BB_REMOVEBUTTON:PAnsiChar = 'TabSRMM/ButtonsBar/RemoveButton';

//////////////////////////////////////////////////////////////////////////
// ModifyButton(global)
//
// wParam = 0
// lParam = (BBButton *) &description
  MS_BB_MODIFYBUTTON:PAnsiChar = 'TabSRMM/ButtonsBar/ModifyButton';


  BBSF_HIDDEN   = 1;
  BBSF_DISABLED = 2;
  BBSF_PUSHED   = 4;
  BBSF_RELEASED = 8;

//////////////////////////////////////////////////////////////////////////
// GetButtonState(local)
//
// wParam =  hContact
// lParam = (BBButton *) &description , only ModuleName and ID used
// Returns BBButton struct with BBSF_ bbbFlags: 
  MS_BB_GETBUTTONSTATE:PansiChar = 'TabSRMM/ButtonsBar/GetButtonState';

//////////////////////////////////////////////////////////////////////////
// SetButtonState (local)
//
// wParam =  hContact
// lParam = (BBButton *) &description , ModuleName, ID,hIcon,Tooltip, and BBSF_ bbbFlags are used
  MS_BB_SETBUTTONSTATE:PAnsiChar = 'TabSRMM/ButtonsBar/SetButtonState';


////////////////////////////////////////////////////////////////
//Events
//
///////////////////////////////////////////////////
// ToolBar loaded event
// wParam = 0;
// lParam = 0;
// This event will be send after module loaded and after each toolbar reset
// You should add your buttons on this event
  ME_MSG_TOOLBARLOADED:PAnsiChar = 'TabSRMM/ButtonsBar/ModuleLoaded';

///////////////////////////////////////////////////
// ButtonClicked event
// wParam = (HANDLE)hContact;
// lParam = (CustomButtonClickData *)&CustomButtonClickData;
// catch to show a popup menu, etc.
  ME_MSG_BUTTONPRESSED:PAnsiChar = 'TabSRMM/ButtonsBar/ButtonPressed';

//event flags
  BBCF_RIGHTBUTTON    = 1;
  BBCF_SHIFTPRESSED   = 2;
  BBCF_CONTROLPRESSED = 4;
  BBCF_ARROWCLICKED   = 8;

type
  pCustomButtonClickData = ^tCustomButtonClickData;
  tCustomButtonClickData = record
    cbSize    :int;
    pt        :TPOINT;    // screen coordinates for menus
    pszModule :PAnsiChar; // button owners name 
    dwButtonId:dword;     // registered button ID
    hwndFrom  :HWND;      // button parents HWND
    hContact  :TMCONTACT;
    flags     :dword;     // BBCF_ flags
  end;

const
//button flags
  BBBF_DISABLED      = $0001;
  BBBF_HIDDEN        = $0002;
  BBBF_ISPUSHBUTTON  = $0004;
  BBBF_ISARROWBUTTON = $0008;
  BBBF_ISCHATBUTTON  = $0010;
  BBBF_ISIMBUTTON    = $0020;
  BBBF_ISLSIDEBUTTON = $0040;
  BBBF_ISRSIDEBUTTON = $0080;
  BBBF_CANBEHIDDEN   = $0100;
  BBBF_ISDUMMYBUTTON = $0200;

type
  tagBBButton = record
    cbSize       :int;   // size of structure
    dwButtonID   :dword; // your button ID, will be combined with pszModuleName for storing settings, etc...  
    pszModuleName:PAnsiChar; // module name without spaces and underline symbols (e.g. "tabsrmm")
    szTooltip    :PWideChar; // button's tooltip
    dwDefPos     :dword; // default order pos of button, counted from window edge (left or right)
                         // use value >100, because internal buttons using 10,20,30... 80, etc
    iButtonWidth :int;   // must be 0
    bbbFlags     :dword; // combine of BBBF_ flags above
    hIcon        :HICON; // Handle to icolib registered icon, it's better to register with pszSection = "TabSRMM/Toolbar"
  end;	
  tBBButton = tagBBButton;


{$ENDIF}