remove old document

git-svn-id: http://svn2.nishi.boats/svn/milsko/trunk@499 b9cfdab3-6d41-4d17-bbe4-086880011989
This commit is contained in:
NishiOwO
2025-10-28 20:40:26 +00:00
parent 1a563ff6c8
commit 603997c082
43 changed files with 499 additions and 4580 deletions

View File

@@ -1,7 +1,7 @@
/* $Id$ */
/*!
* %file Mw/Widget/Button.h
* %brief Button widget
* @file Mw/Widget/Button.h
* @brief Button widget
*/
#ifndef __MW_WIDGET_BUTTON_H__
#define __MW_WIDGET_BUTTON_H__
@@ -14,7 +14,7 @@ extern "C" {
#endif
/*!
* %brief Button widget class
* @brief Button widget class
*/
MWDECL MwClass MwButtonClass;

View File

@@ -1,7 +1,7 @@
/* $Id: CheckBox.h 206 2025-10-07 15:10:46Z nishi $ */
/*!
* %file Mw/Widget/CheckBox.h
* %brief CheckBox widget
* @file Mw/Widget/CheckBox.h
* @brief CheckBox widget
*/
#ifndef __MW_WIDGET_CHECKBOX_H__
#define __MW_WIDGET_CHECKBOX_H__
@@ -14,7 +14,7 @@ extern "C" {
#endif
/*!
* %brief CheckBox widget class
* @brief CheckBox widget class
*/
MWDECL MwClass MwCheckBoxClass;

View File

@@ -1,7 +1,7 @@
/* $Id$ */
/*!
* %file Mw/Widget/Entry.h
* %brief Entry widget
* @file Mw/Widget/Entry.h
* @brief Entry widget
*/
#ifndef __MW_WIDGET_ENTRY_H__
#define __MW_WIDGET_ENTRY_H__
@@ -14,7 +14,7 @@ extern "C" {
#endif
/*!
* %brief Entry widget class
* @brief Entry widget class
*/
MWDECL MwClass MwEntryClass;

View File

@@ -1,7 +1,7 @@
/* $Id$ */
/*!
* %file Mw/Widget/Frame.h
* %brief Frame widget
* @file Mw/Widget/Frame.h
* @brief Frame widget
*/
#ifndef __MW_WIDGET_FRAME_H__
#define __MW_WIDGET_FRAME_H__
@@ -14,7 +14,7 @@ extern "C" {
#endif
/*!
* %brief Frame widget class
* @brief Frame widget class
*/
MWDECL MwClass MwFrameClass;

View File

@@ -1,7 +1,7 @@
/* $Id$ */
/*!
* %file Mw/Widget/Image.h
* %brief Image widget
* @file Mw/Widget/Image.h
* @brief Image widget
*/
#ifndef __MW_WIDGET_IMAGE_H__
#define __MW_WIDGET_IMAGE_H__
@@ -14,7 +14,7 @@ extern "C" {
#endif
/*!
* %brief Image widget class
* @brief Image widget class
*/
MWDECL MwClass MwImageClass;

View File

@@ -1,7 +1,7 @@
/* $Id$ */
/*!
* %file Mw/Widget/Label.h
* %brief Label widget
* @file Mw/Widget/Label.h
* @brief Label widget
*/
#ifndef __MW_WIDGET_LABEL_H__
#define __MW_WIDGET_LABEL_H__
@@ -14,7 +14,7 @@ extern "C" {
#endif
/*!
* %brief Label widget class
* @brief Label widget class
*/
MWDECL MwClass MwLabelClass;

View File

@@ -1,7 +1,7 @@
/* $Id$ */
/*!
* %file Mw/Widget/ListBox.h
* %brief ListBox widget
* @file Mw/Widget/ListBox.h
* @brief ListBox widget
*/
#ifndef __MW_WIDGET_LISTBOX_H__
#define __MW_WIDGET_LISTBOX_H__
@@ -15,71 +15,71 @@ extern "C" {
#endif
/*!
* %brief ListBox widget class
* @brief ListBox widget class
*/
MWDECL MwClass MwListBoxClass;
/*!
* %brief Creates a listbox packet
* %return Packet
* @brief Creates a listbox packet
* @return Packet
*/
MWDECL MwListBoxPacket* MwListBoxCreatePacket(void);
/*!
* %brief Destroys a listbox packet
* %param packet Packet
* @brief Destroys a listbox packet
* @param packet Packet
*/
MWDECL void MwListBoxDestroyPacket(MwListBoxPacket* packet);
/*!
* %brief Inserts a new item to a packet
* %param packet Packet
* %param index Index
* %return Index
* @brief Inserts a new item to a packet
* @param packet Packet
* @param index Index
* @return Index
*/
MWDECL int MwListBoxPacketInsert(MwListBoxPacket* packet, int index);
/*!
* %brief Sets a column of item in a packet
* %param packet Packet
* %param index Index
* %param col Column
* %param text Text
* @brief Sets a column of item in a packet
* @param packet Packet
* @param index Index
* @param col Column
* @param text Text
*/
MWDECL void MwListBoxPacketSet(MwListBoxPacket* packet, int index, int col, const char* text);
/*!
* %brief Sets an icon of item in a packet
* %param packet Packet
* %param index Index
* %param icon Icon
* @brief Sets an icon of item in a packet
* @param packet Packet
* @param index Index
* @param icon Icon
*/
MWDECL void MwListBoxPacketSetIcon(MwListBoxPacket* packet, int index, MwLLPixmap icon);
/*!
* %brief Inserts item on the listbox
* %param handle Widget
* %param index Index
* %param packet Packet
* @brief Inserts item on the listbox
* @param handle Widget
* @param index Index
* @param packet Packet
*/
MwInline void MwListBoxInsert(MwWidget handle, int index, void* packet) {
MwVaWidgetExecute(handle, "mwListBoxInsert", NULL, index, packet);
}
/*!
* %brief Deletes item from the listbox
* %param handle Widget
* %param index Index
* @brief Deletes item from the listbox
* @param handle Widget
* @param index Index
*/
MwInline void MwListBoxDelete(MwWidget handle, int index) {
MwVaWidgetExecute(handle, "mwListboxDelete", NULL, index);
};
/*!
* %brief Gets item from the listbox
* %param handle Widget
* %param index Index
* %return Item
* @brief Gets item from the listbox
* @param handle Widget
* @param index Index
* @return Item
*/
MwInline const char* MwListBoxGet(MwWidget handle, int index) {
const char* out;
@@ -88,18 +88,18 @@ MwInline const char* MwListBoxGet(MwWidget handle, int index) {
};
/*!
* %brief Sets an item width of the listbox
* %param handle Widget
* %param index Column index
* %param width Width
* @brief Sets an item width of the listbox
* @param handle Widget
* @param index Column index
* @param width Width
*/
MwInline void MwListBoxSetWidth(MwWidget handle, int index, int width) {
MwVaWidgetExecute(handle, "mwListBoxSetWidth", NULL, index, width);
};
/*!
* %brief Resets the listbox
* %param handle Widget
* @brief Resets the listbox
* @param handle Widget
*/
MwInline void MwListBoxReset(MwWidget handle) {
MwVaWidgetExecute(handle, "mwListBoxReset", NULL);

View File

@@ -1,7 +1,7 @@
/* $Id$ */
/*!
* %file Mw/Widget/Menu.h
* %brief Menu widget
* @file Mw/Widget/Menu.h
* @brief Menu widget
*/
#ifndef __MW_WIDGET_MENU_H__
#define __MW_WIDGET_MENU_H__
@@ -15,16 +15,16 @@ extern "C" {
#endif
/*!
* %brief Menu widget class
* @brief Menu widget class
*/
MWDECL MwClass MwMenuClass;
/*!
* %brief Adds a menu
* %param handle Widget
* %param menu Menu
* %param name Menu name
* %return Menu
* @brief Adds a menu
* @param handle Widget
* @param menu Menu
* @param name Menu name
* @return Menu
*/
MwInline MwMenu MwMenuAdd(MwWidget handle, MwMenu menu, const char* name) {
MwMenu out;

View File

@@ -1,7 +1,7 @@
/* $Id$ */
/*!
* %file Mw/Widget/NumberEntry.h
* %brief NumberEntry widget
* @file Mw/Widget/NumberEntry.h
* @brief NumberEntry widget
*/
#ifndef __MW_WIDGET_NUMBERENTRY_H__
#define __MW_WIDGET_NUMBERENTRY_H__
@@ -14,7 +14,7 @@ extern "C" {
#endif
/*!
* %brief NumberEntry widget class
* @brief NumberEntry widget class
*/
MWDECL MwClass MwNumberEntryClass;

View File

@@ -1,7 +1,7 @@
/* $Id$ */
/*!
* %file Mw/Widget/OpenGL.h
* %brief OpenGL widget
* @file Mw/Widget/OpenGL.h
* @brief OpenGL widget
*/
#ifndef __MW_WIDGET_OPENGL_H__
#define __MW_WIDGET_OPENGL_H__
@@ -26,23 +26,23 @@ extern "C" {
#endif
/*!
* %brief OpenGL widget class
* @brief OpenGL widget class
*/
MWDECL MwClass MwOpenGLClass;
/*!
* %brief Make a widget current OpenGL context
* %param handle Widget
* @brief Make a widget current OpenGL context
* @param handle Widget
*/
MwInline void MwOpenGLMakeCurrent(MwWidget handle) {
MwVaWidgetExecute(handle, "mwOpenGLMakeCurrent", NULL);
};
/*!
* %brief Get a procedure from OpenGL
* %param handle Widget
* %param name Name
* %return Procedure
* @brief Get a procedure from OpenGL
* @param handle Widget
* @param name Name
* @return Procedure
*/
MwInline void* MwOpenGLGetProcAddress(MwWidget handle, const char* name) {
void* out;
@@ -51,8 +51,8 @@ MwInline void* MwOpenGLGetProcAddress(MwWidget handle, const char* name) {
};
/*!
* %brief Swaps the buffer of OpenGL context
* %param handle Widget
* @brief Swaps the buffer of OpenGL context
* @param handle Widget
*/
MwInline void MwOpenGLSwapBuffer(MwWidget handle) {
MwVaWidgetExecute(handle, "mwOpenGLSwapBuffer", NULL);

View File

@@ -1,7 +1,7 @@
/* $Id$ */
/*!
* %file Mw/Widget/ScrollBar.h
* %brief ScrollBar widget
* @file Mw/Widget/ScrollBar.h
* @brief ScrollBar widget
*/
#ifndef __MW_WIDGET_SCROLLBAR_H__
#define __MW_WIDGET_SCROLLBAR_H__
@@ -15,14 +15,14 @@ extern "C" {
#endif
/*!
* %brief ScrollBar widget class
* @brief ScrollBar widget class
*/
MWDECL MwClass MwScrollBarClass;
/*!
* %brief Calculates a visible length of scrollbar
* %param handle Widget
* %return Visible length
* @brief Calculates a visible length of scrollbar
* @param handle Widget
* @return Visible length
*/
MwInline int MwScrollBarGetVisibleLength(MwWidget handle) {
int out;

View File

@@ -1,7 +1,7 @@
/* $Id$ */
/*!
* %file Mw/Widget/SubMenu.h
* %brief SubMenu widget
* @file Mw/Widget/SubMenu.h
* @brief SubMenu widget
*/
#ifndef __MW_WIDGET_SUBMENU_H__
#define __MW_WIDGET_SUBMENU_H__
@@ -15,7 +15,7 @@ extern "C" {
#endif
/*!
* %brief SubMenu widget class
* @brief SubMenu widget class
*/
MWDECL MwClass MwSubMenuClass;

View File

@@ -1,7 +1,7 @@
/* $Id$ */
/*!
* %file Mw/Widget/Viewport.h
* %brief Viewport widget
* @file Mw/Widget/Viewport.h
* @brief Viewport widget
*/
#ifndef __MW_WIDGET_VIEWPORT_H__
#define __MW_WIDGET_VIEWPORT_H__
@@ -15,14 +15,14 @@ extern "C" {
#endif
/*!
* %brief Viewport widget class
* @brief Viewport widget class
*/
MWDECL MwClass MwViewportClass;
/*!
* %brief Get parent widget where widgets should be placed
* %param handle Widget
* %return Widget
* @brief Get parent widget where widgets should be placed
* @param handle Widget
* @return Widget
*/
MwInline MwWidget MwViewportGetViewport(MwWidget handle) {
MwWidget out;
@@ -31,10 +31,10 @@ MwInline MwWidget MwViewportGetViewport(MwWidget handle) {
};
/*!
* %brief Set viewport size
* %param handle Widget
* %param w Width
* %param h Height
* @brief Set viewport size
* @param handle Widget
* @param w Width
* @param h Height
*/
MwInline void MwViewportSetSize(MwWidget handle, int w, int h) {
MwVaWidgetExecute(handle, "mwViewportSetSize", NULL, w, h);

View File

@@ -1,8 +1,8 @@
/* $Id$ */
/*!
* %file Mw/Widget/Vulkan.h
* %brief Vulkan widget
* %warning This header is not documented yet
* @file Mw/Widget/Vulkan.h
* @brief Vulkan widget
* @warning This header is not documented yet
*/
/**
@@ -29,89 +29,89 @@ extern "C" {
#endif
/*!
* %brief Vulkan widget class
* @brief Vulkan widget class
*/
MWDECL MwClass MwVulkanClass;
/*!
* %brief Add an extension to the list of extensions to enable prior to initialization.
* %warning This must be called before MwCreateWidget.
* @brief Add an extension to the list of extensions to enable prior to initialization.
* @warning This must be called before MwCreateWidget.
*/
MWDECL void MwVulkanEnableExtension(const char* ext_name);
/*!
* %brief Add an layer to the list of layers to enable prior to initialization.
* %warning This must be called before MwCreateWidget.
* @brief Add an layer to the list of layers to enable prior to initialization.
* @warning This must be called before MwCreateWidget.
*/
MWDECL void MwVulkanEnableLayer(const char* ext_name);
/*!
* %brief Configuration options that can be passed to setup Vulkan before a widget is created.
* @brief Configuration options that can be passed to setup Vulkan before a widget is created.
*/
typedef struct MwVulkanConfig_T {
/*!
* %brief Vulkan API version (default: VK_API_VERSION_1_0)
* @brief Vulkan API version (default: VK_API_VERSION_1_0)
*/
uint32_t api_version;
/*!
* %brief Vulkan version (default: VK_VERSION_1_0)
* @brief Vulkan version (default: VK_VERSION_1_0)
*/
uint32_t vk_version;
/*!
* %brief Whether or not to enable validation layers (default: false)
* @brief Whether or not to enable validation layers (default: false)
*/
VkBool32 validation_layers;
} MwVulkanConfig;
/*!
* %brief Configure Vulkan prior to initializing the widget.
* %warning This must be called before MwCreateWidget.
* %warning The configuration provided will be used for future initializations of the Vulkan widget (unless it's changed)
* @brief Configure Vulkan prior to initializing the widget.
* @warning This must be called before MwCreateWidget.
* @warning The configuration provided will be used for future initializations of the Vulkan widget (unless it's changed)
*/
MWDECL void MwVulkanConfigure(MwVulkanConfig cfg);
/*!
* %brief Field that can be gotten from Vulkan.
* @brief Field that can be gotten from Vulkan.
*/
typedef enum MwVulkanField_T {
/*!
* %brief The address of the vulkan widget's vkGetInstanceProcAddr function (PFN_vkGetInstanceProcAddr)
* @brief The address of the vulkan widget's vkGetInstanceProcAddr function (PFN_vkGetInstanceProcAddr)
*/
MwVulkanField_GetInstanceProcAddr = 0,
/*!
* %brief The address of the vulkan widget's instance (VkInstance)
* @brief The address of the vulkan widget's instance (VkInstance)
*/
MwVulkanField_Instance,
/*!
* %brief The address of the vulkan widget's surface (VkSurfaceKHR)
* @brief The address of the vulkan widget's surface (VkSurfaceKHR)
*/
MwVulkanField_Surface,
/*!
* %brief The address of the vulkan widget's physical device (VkPhysicalDevice)
* @brief The address of the vulkan widget's physical device (VkPhysicalDevice)
*/
MwVulkanField_PhysicalDevice,
/*!
* %brief The address of the vulkan widget's logical device (VkDevice)
* @brief The address of the vulkan widget's logical device (VkDevice)
*/
MwVulkanField_LogicalDevice,
/*!
* %brief The address of the index that the vulkan widget uses for the graphics queue (uint32_t *)
* @brief The address of the index that the vulkan widget uses for the graphics queue (uint32_t *)
*/
MwVulkanField_GraphicsQueueIndex,
/*!
* %brief The address of the index that the vulkan widget uses for the present queue (uint32_t *)
* @brief The address of the index that the vulkan widget uses for the present queue (uint32_t *)
*/
MwVulkanField_PresentQueueIndex,
MwVulkanField_GraphicsQueue,
/*!
* %brief The address of the vulkan widget's graphics queue (VkQueue)
* @brief The address of the vulkan widget's graphics queue (VkQueue)
*/
MwVulkanField_PresentQueue,
} MwVulkanField;
/*!
* %brief Function for getting a field from within Vulkan.
* %warning Consult the documentation for MwVulkanField to know what type is expected for out.
* @brief Function for getting a field from within Vulkan.
* @warning Consult the documentation for MwVulkanField to know what type is expected for out.
*/
MwInline void* MwVulkanGetField(MwWidget handle, MwVulkanField field, MwErrorEnum* out) {
void* field_out;
@@ -120,7 +120,7 @@ MwInline void* MwVulkanGetField(MwWidget handle, MwVulkanField field, MwErrorEnu
};
/*!
* %brief Return whether Vulkan is installed on the target platform.
* @brief Return whether Vulkan is installed on the target platform.
*/
MWDECL VkBool32 MwVulkanSupported(void);

View File

@@ -1,7 +1,7 @@
/* $Id$ */
/*!
* %file Mw/Widget/Window.h
* %brief Window widget
* @file Mw/Widget/Window.h
* @brief Window widget
*/
#ifndef __MW_WIDGET_WINDOW_H__
#define __MW_WIDGET_WINDOW_H__
@@ -15,14 +15,14 @@ extern "C" {
#endif
/*!
* %brief Window widget class
* @brief Window widget class
*/
MWDECL MwClass MwWindowClass;
/*!
* %brief Makes window borderless
* %param handle Widget
* %param toggle Toggle
* @brief Makes window borderless
* @param handle Widget
* @param toggle Toggle
*/
MwInline void MwWindowMakeBorderless(MwWidget handle, int toggle) {
MwVaWidgetExecute(handle, "mwWindowMakeBorderless", NULL, toggle);