diff options
Diffstat (limited to 'intern/ghost/intern/GHOST_SystemWin32.h')
| -rw-r--r-- | intern/ghost/intern/GHOST_SystemWin32.h | 163 |
1 files changed, 82 insertions, 81 deletions
diff --git a/intern/ghost/intern/GHOST_SystemWin32.h b/intern/ghost/intern/GHOST_SystemWin32.h index f63ad38d0cc..6a756d35872 100644 --- a/intern/ghost/intern/GHOST_SystemWin32.h +++ b/intern/ghost/intern/GHOST_SystemWin32.h @@ -57,9 +57,9 @@ class GHOST_EventDragnDrop; /** * WIN32 Implementation of GHOST_System class. - * @see GHOST_System. - * @author Maarten Gribnau - * @date May 10, 2001 + * \see GHOST_System. + * \author Maarten Gribnau + * \date May 10, 2001 */ class GHOST_SystemWin32 : public GHOST_System { public: @@ -81,7 +81,7 @@ public: * Returns the system time. * Returns the number of milliseconds since the start of the system process. * This overloaded method uses the high frequency timer if available. - * @return The number of milliseconds. + * \return The number of milliseconds. */ virtual GHOST_TUns64 getMilliSeconds() const; @@ -91,13 +91,13 @@ public: /** * Returns the number of displays on this system. - * @return The number of displays. + * \return The number of displays. */ virtual GHOST_TUns8 getNumDisplays() const; /** * Returns the dimensions of the main display on this system. - * @return The dimension of the main display. + * \return The dimension of the main display. */ virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const; @@ -105,17 +105,17 @@ public: * Create a new window. * The new window is added to the list of windows managed. * Never explicitly delete the window, use disposeWindow() instead. - * @param title The name of the window (displayed in the title bar of the window if the OS supports it). - * @param left The coordinate of the left edge of the window. - * @param top The coordinate of the top edge of the window. - * @param width The width the window. - * @param height The height the window. - * @param state The state of the window when opened. - * @param type The type of drawing context installed in this window. - * @param stereoVisual Stereo visual for quad buffered stereo. - * @param numOfAASamples Number of samples used for AA (zero if no AA) - * @param parentWindow Parent (embedder) window - * @return The new window (or 0 if creation failed). + * \param title The name of the window (displayed in the title bar of the window if the OS supports it). + * \param left The coordinate of the left edge of the window. + * \param top The coordinate of the top edge of the window. + * \param width The width the window. + * \param height The height the window. + * \param state The state of the window when opened. + * \param type The type of drawing context installed in this window. + * \param stereoVisual Stereo visual for quad buffered stereo. + * \param numOfAASamples Number of samples used for AA (zero if no AA) + * \param parentWindow Parent (embedder) window + * \return The new window (or 0 if creation failed). */ virtual GHOST_IWindow *createWindow( const STR_String& title, @@ -131,8 +131,8 @@ public: /** * Gets events from the system and stores them in the queue. - * @param waitForEvent Flag to wait for an event (or return immediately). - * @return Indication of the presence of events. + * \param waitForEvent Flag to wait for an event (or return immediately). + * \return Indication of the presence of events. */ virtual bool processEvents(bool waitForEvent); @@ -143,17 +143,17 @@ public: /** * Returns the current location of the cursor (location in screen coordinates) - * @param x The x-coordinate of the cursor. - * @param y The y-coordinate of the cursor. - * @return Indication of success. + * \param x The x-coordinate of the cursor. + * \param y The y-coordinate of the cursor. + * \return Indication of success. */ virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const; /** * Updates the location of the cursor (location in screen coordinates). - * @param x The x-coordinate of the cursor. - * @param y The y-coordinate of the cursor. - * @return Indication of success. + * \param x The x-coordinate of the cursor. + * \param y The y-coordinate of the cursor. + * \return Indication of success. */ virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y); @@ -163,41 +163,41 @@ public: /** * Returns the state of all modifier keys. - * @param keys The state of all modifier keys (true == pressed). - * @return Indication of success. + * \param keys The state of all modifier keys (true == pressed). + * \return Indication of success. */ virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const; /** * Returns the state of the mouse buttons (ouside the message queue). - * @param buttons The state of the buttons. - * @return Indication of success. + * \param buttons The state of the buttons. + * \return Indication of success. */ virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const; /** * Returns unsinged char from CUT_BUFFER0 - * @param selection Used by X11 only - * @return Returns the Clipboard + * \param selection Used by X11 only + * \return Returns the Clipboard */ virtual GHOST_TUns8 *getClipboard(bool selection) const; /** * Puts buffer to system clipboard - * @param selection Used by X11 only - * @return No return + * \param selection Used by X11 only + * \return No return */ virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const; /** * Creates a drag'n'drop event and pushes it immediately onto the event queue. * Called by GHOST_DropTargetWin32 class. - * @param eventType The type of drag'n'drop event - * @param draggedObjectType The type object concerned (currently array of file names, string, ?bitmap) - * @param mouseX x mouse coordinate (in window coordinates) - * @param mouseY y mouse coordinate - * @param window The window on which the event occurred - * @return Indication whether the event was handled. + * \param eventType The type of drag'n'drop event + * \param draggedObjectType The type object concerned (currently array of file names, string, ?bitmap) + * \param mouseX x mouse coordinate (in window coordinates) + * \param mouseY y mouse coordinate + * \param window The window on which the event occurred + * \return Indication whether the event was handled. */ static GHOST_TSuccess pushDragDropEvent(GHOST_TEventType eventType, GHOST_TDragnDropTypes draggedObjectType, GHOST_IWindow *window, int mouseX, int mouseY, void *data); @@ -211,33 +211,33 @@ protected: /** * Initializes the system. * For now, it justs registers the window class (WNDCLASS). - * @return A success value. + * \return A success value. */ virtual GHOST_TSuccess init(); /** * Closes the system down. - * @return A success value. + * \return A success value. */ virtual GHOST_TSuccess exit(); /** * Converts raw WIN32 key codes from the wndproc to GHOST keys. - * @param window-> The window for this handling - * @param vKey The virtual key from hardKey - * @param ScanCode The ScanCode of pressed key (simular to PS/2 Set 1) - * @param extend Flag if key is not primerly (left or right) - * @return The GHOST key (GHOST_kKeyUnknown if no match). + * \param window-> The window for this handling + * \param vKey The virtual key from hardKey + * \param ScanCode The ScanCode of pressed key (simular to PS/2 Set 1) + * \param extend Flag if key is not primerly (left or right) + * \return The GHOST key (GHOST_kKeyUnknown if no match). */ virtual GHOST_TKey convertKey(GHOST_IWindow *window, short vKey, short ScanCode, short extend) const; /** * Catches raw WIN32 key codes from WM_INPUT in the wndproc. - * @param window The window for this handling - * @param raw RawInput structure with detailed info about the key event - * @param keyDown Pointer flag that specify if a key is down - * @param vk Pointer to virtual key - * @return The GHOST key (GHOST_kKeyUnknown if no match). + * \param window The window for this handling + * \param raw RawInput structure with detailed info about the key event + * \param keyDown Pointer flag that specify if a key is down + * \param vk Pointer to virtual key + * \return The GHOST key (GHOST_kKeyUnknown if no match). */ virtual GHOST_TKey hardKey(GHOST_IWindow *window, RAWINPUT const& raw, int *keyDown, char *vk); @@ -246,32 +246,32 @@ protected: * With the modifier keys, we want to distinguish left and right keys. * Sometimes this is not possible (Windows ME for instance). Then, we want * events generated for both keys. - * @param window The window receiving the event (the active window). + * \param window The window receiving the event (the active window). */ GHOST_EventKey *processModifierKeys(GHOST_IWindow *window); /** * Creates mouse button event. - * @param type The type of event to create. - * @param window The window receiving the event (the active window). - * @param mask The button mask of this event. - * @return The event created. + * \param type The type of event to create. + * \param window The window receiving the event (the active window). + * \param mask The button mask of this event. + * \return The event created. */ static GHOST_EventButton *processButtonEvent(GHOST_TEventType type, GHOST_IWindow *window, GHOST_TButtonMask mask); /** * Creates cursor event. - * @param type The type of event to create. - * @param window The window receiving the event (the active window). - * @return The event created. + * \param type The type of event to create. + * \param window The window receiving the event (the active window). + * \return The event created. */ static GHOST_EventCursor *processCursorEvent(GHOST_TEventType type, GHOST_IWindow *Iwindow); /** * Creates a mouse wheel event. - * @param window The window receiving the event (the active window). - * @param wParam The wParam from the wndproc - * @param lParam The lParam from the wndproc + * \param window The window receiving the event (the active window). + * \param wParam The wParam from the wndproc + * \param lParam The lParam from the wndproc */ static GHOST_EventWheel *processWheelEvent(GHOST_IWindow *window, WPARAM wParam, LPARAM lParam); @@ -279,31 +279,31 @@ protected: * Creates a key event and updates the key data stored locally (m_modifierKeys). * In most cases this is a straightforward conversion of key codes. * For the modifier keys however, we want to distinguish left and right keys. - * @param window The window receiving the event (the active window). - * @param raw RawInput structure with detailed info about the key event + * \param window The window receiving the event (the active window). + * \param raw RawInput structure with detailed info about the key event */ static GHOST_EventKey *processKeyEvent(GHOST_IWindow *window, RAWINPUT const& raw); /** * Process special keys (VK_OEM_*), to see if current key layout * gives us anything special, like ! on french AZERTY. - * @param window The window receiving the event (the active window). - * @param vKey The virtual key from hardKey - * @param ScanCode The ScanCode of pressed key (simular to PS/2 Set 1) + * \param window The window receiving the event (the active window). + * \param vKey The virtual key from hardKey + * \param ScanCode The ScanCode of pressed key (simular to PS/2 Set 1) */ virtual GHOST_TKey processSpecialKey(GHOST_IWindow *window, short vKey, short scanCode) const; /** * Creates a window event. - * @param type The type of event to create. - * @param window The window receiving the event (the active window). - * @return The event created. + * \param type The type of event to create. + * \param window The window receiving the event (the active window). + * \return The event created. */ static GHOST_Event *processWindowEvent(GHOST_TEventType type, GHOST_IWindow *window); /** * Handles minimum window size. - * @param minmax The MINMAXINFO structure. + * \param minmax The MINMAXINFO structure. */ static void processMinMaxInfo(MINMAXINFO *minmax); @@ -312,22 +312,22 @@ protected: * Handles Motion and Button events from a SpaceNavigator or related device. * Instead of returning an event object, this function communicates directly * with the GHOST_NDOFManager. - * @param raw RawInput structure with detailed info about the NDOF event - * @return Whether an event was generated and sent. + * \param raw RawInput structure with detailed info about the NDOF event + * \return Whether an event was generated and sent. */ bool processNDOF(RAWINPUT const& raw); #endif /** * Returns the local state of the modifier keys (from the message queue). - * @param keys The state of the keys. + * \param keys The state of the keys. */ inline virtual void retrieveModifierKeys(GHOST_ModifierKeys& keys) const; /** * Stores the state of the modifier keys locally. * For internal use only! - * @param keys The new state of the modifier keys. + * param keys The new state of the modifier keys. */ inline virtual void storeModifierKeys(const GHOST_ModifierKeys& keys); @@ -343,12 +343,13 @@ protected: /** * Toggles console - * @action 0 - Hides - * 1 - Shows - * 2 - Toggles - * 3 - Hides if it runs not from command line - * * - Does nothing - * @return current status (1 -visible, 0 - hidden) + * \param action + * - 0 - Hides + * - 1 - Shows + * - 2 - Toggles + * - 3 - Hides if it runs not from command line + * - * - Does nothing + * \return current status (1 -visible, 0 - hidden) */ int toggleConsole(int action); |