NeoMutt  2023-11-03-85-g512e01
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
functions.h File Reference

Browser functions. More...

+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  BrowserFunction
 A NeoMutt function. More...
 

Typedefs

typedef int(* browser_function_t) (struct BrowserPrivateData *priv, int op)
 

Functions

int browser_function_dispatcher (struct MuttWindow *win, int op)
 Perform a Browser function.
 

Detailed Description

Browser functions.

Authors
  • Richard Russon

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file functions.h.

Typedef Documentation

◆ browser_function_t

typedef int(* browser_function_t) (struct BrowserPrivateData *priv, int op)

Definition at line 38 of file functions.h.

Function Documentation

◆ browser_function_dispatcher()

int browser_function_dispatcher ( struct MuttWindow win,
int  op 
)

Perform a Browser function.

Parameters
winWindow for the Browser
opOperation to perform, e.g. OP_GOTO_PARENT
Return values
numFunctionRetval, e.g. FR_SUCCESS

Definition at line 1138 of file functions.c.

1139{
1140 if (!win)
1141 {
1143 return FR_ERROR;
1144 }
1145
1146 struct BrowserPrivateData *priv = win->parent->wdata;
1147 if (!priv)
1148 return FR_ERROR;
1149
1150 int rc = FR_UNKNOWN;
1151 for (size_t i = 0; BrowserFunctions[i].op != OP_NULL; i++)
1152 {
1153 const struct BrowserFunction *fn = &BrowserFunctions[i];
1154 if (fn->op == op)
1155 {
1156 rc = fn->function(priv, op);
1157 break;
1158 }
1159 }
1160
1161 return rc;
1162}
static const char * Not_available_in_this_menu
Error message for unavailable functions.
Definition: functions.c:54
static const struct BrowserFunction BrowserFunctions[]
All the NeoMutt functions that the Browser supports.
Definition: functions.c:1100
@ FR_UNKNOWN
Unknown function.
Definition: dispatcher.h:33
@ FR_ERROR
Valid function - error occurred.
Definition: dispatcher.h:38
#define mutt_error(...)
Definition: logging2.h:92
#define _(a)
Definition: message.h:28
A NeoMutt function.
Definition: functions.h:44
int op
Op code, e.g. OP_MAIN_LIMIT.
Definition: functions.h:45
browser_function_t function
Function to call.
Definition: functions.h:46
Private state data for the Browser.
Definition: private_data.h:34
void * wdata
Private data.
Definition: mutt_window.h:145
struct MuttWindow * parent
Parent Window.
Definition: mutt_window.h:135
+ Here is the caller graph for this function: