action.h File Reference

#include <libbase/libbase.h>
#include <libbase/plist.h>
#include "server.h"

Include dependency graph for action.h:

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

Go to the source code of this file.

Typedefs
typedef struct _wlmaker_action_handle_t	wlmaker_action_handle_t

Enumerations
enum	wlmaker_action_t {   WLMAKER_ACTION_NONE , WLMAKER_ACTION_QUIT , WLMAKER_ACTION_LOCK_SCREEN , WLMAKER_ACTION_LOCK_INHIBIT_BEGIN ,   WLMAKER_ACTION_LOCK_INHIBIT_END , WLMAKER_ACTION_LAUNCH_TERMINAL , WLMAKER_ACTION_SHELL_EXECUTE , WLMAKER_ACTION_WORKSPACE_TO_PREVIOUS ,   WLMAKER_ACTION_WORKSPACE_TO_NEXT , WLMAKER_ACTION_TASK_TO_PREVIOUS , WLMAKER_ACTION_TASK_TO_NEXT , WLMAKER_ACTION_WINDOW_RAISE ,   WLMAKER_ACTION_WINDOW_LOWER , WLMAKER_ACTION_WINDOW_TOGGLE_FULLSCREEN , WLMAKER_ACTION_WINDOW_TOGGLE_MAXIMIZED , WLMAKER_ACTION_WINDOW_MAXIMIZE ,   WLMAKER_ACTION_WINDOW_UNMAXIMIZE , WLMAKER_ACTION_WINDOW_FULLSCREEN , WLMAKER_ACTION_WINDOW_SHADE , WLMAKER_ACTION_WINDOW_UNSHADE ,   WLMAKER_ACTION_WINDOW_CLOSE , WLMAKER_ACTION_WINDOW_TO_NEXT_WORKSPACE , WLMAKER_ACTION_WINDOW_TO_PREVIOUS_WORKSPACE , WLMAKER_ACTION_ROOT_MENU ,   WLMAKER_ACTION_SWITCH_TO_VT1 , WLMAKER_ACTION_SWITCH_TO_VT2 , WLMAKER_ACTION_SWITCH_TO_VT3 , WLMAKER_ACTION_SWITCH_TO_VT4 ,   WLMAKER_ACTION_SWITCH_TO_VT5 , WLMAKER_ACTION_SWITCH_TO_VT6 , WLMAKER_ACTION_SWITCH_TO_VT7 , WLMAKER_ACTION_SWITCH_TO_VT8 ,   WLMAKER_ACTION_SWITCH_TO_VT9 , WLMAKER_ACTION_SWITCH_TO_VT10 , WLMAKER_ACTION_SWITCH_TO_VT11 , WLMAKER_ACTION_SWITCH_TO_VT12 }

Functions
wlmaker_action_handle_t *	wlmaker_action_bind_keys (wlmaker_server_t *server_ptr, bspl_dict_t *keybindings_dict_ptr)
void	wlmaker_action_unbind_keys (wlmaker_action_handle_t *handle_ptr)
void	wlmaker_action_execute (wlmaker_server_t *server_ptr, wlmaker_action_t action, void *arg_ptr)

Variables
const char *	wlmaker_action_config_dict_key
const bspl_enum_desc_t	wlmaker_action_desc []
const bs_test_case_t	wlmaker_action_test_cases []

Detailed Description

Copyright

Copyright 2024 Google LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Typedef Documentation

wlmaker_action_handle_t

typedef struct _wlmaker_action_handle_t wlmaker_action_handle_t

Forward declaration: Handle for bound actions.

Enumeration Type Documentation

wlmaker_action_t

enum wlmaker_action_t

wlmaker actions. Can be bound to keys. Also

See also

wlmaker_action_desc.

Function Documentation

wlmaker_action_bind_keys()

wlmaker_action_handle_t * wlmaker_action_bind_keys	(	wlmaker_server_t *	server_ptr,
		bspl_dict_t *	keybindings_dict_ptr
	)

Binds the actions specified in the config dictionary.

Parameters

server_ptr
keybindings_dict_ptr

Returns

A bound action handle, or NULL on error.

wlmaker_action_execute()

void wlmaker_action_execute	(	wlmaker_server_t *	server_ptr,
		wlmaker_action_t	action,
		void *	arg_ptr
	)

Executes the given action on wlmaker.

Parameters

server_ptr
action
arg_ptr

wlmaker_action_unbind_keys()

void wlmaker_action_unbind_keys

(

wlmaker_action_handle_t *

handle_ptr

)

Unbinds actions previously bound by wlmaker_action_bind_keys.

Parameters

handle_ptr

Variable Documentation

wlmaker_action_config_dict_key

const char* wlmaker_action_config_dict_key

extern

Key to lookup the dict from the config dictionary.

wlmaker_action_desc

const bspl_enum_desc_t wlmaker_action_desc[]

extern

The actions that can be bound.

wlmaker_action_test_cases

const bs_test_case_t wlmaker_action_test_cases[]

extern

Unit test cases.

Test cases for key bindings.