Plugins API reference

Function Description
hexedit.file_size() File size in bytes
hexedit.file_path() Path to the current file
hexedit.read_bytes(offset, length) Read raw bytes
hexedit.read_uint8(offset) Read unsigned 8-bit integer
hexedit.read_uint16(offset, big_endian=False) Read unsigned 16-bit integer
hexedit.read_uint32(offset, big_endian=False) Read unsigned 32-bit integer
hexedit.read_uint64(offset, big_endian=False) Read unsigned 64-bit integer
hexedit.read_int8(offset) Read signed 8-bit integer
hexedit.read_int16(offset, big_endian=False) Read signed 16-bit integer
hexedit.read_int32(offset, big_endian=False) Read signed 32-bit integer
hexedit.read_int64(offset, big_endian=False) Read signed 64-bit integer
hexedit.read_cstring(offset, max_length=4096) Read null-terminated string
hexedit.find_bytes(pattern, start_offset=0, max_search=0xFFFFFFFF) Search for byte pattern, returns offset or -1
hexedit.add_tag(name, offset, length, color="", type="") Add a tag to the hex view
hexedit.set_alias(name, value) Set a numeric alias
hexedit.get_alias(name) Get a numeric alias (0 if not found)
hexedit.has_alias(name) Check if a numeric alias exists
hexedit.set_str_alias(name, value) Set a string alias
hexedit.get_str_alias(name) Get a string alias
hexedit.set_status(text, duration_ms=3000) Show a temporary status message
hexedit.get_selection() Get selection as (start, end) tuple
hexedit.set_selection(start, end) Set the selection range
hexedit.is_cancelled() Check if the plugin has been cancelled
hexedit.register_command(id, name, handler, shortcut="") Register a command in the palette