VirtualBox

Changeset 57027 in vbox for trunk


Ignore:
Timestamp:
Jul 20, 2015 4:41:01 PM (9 years ago)
Author:
vboxsync
Message:

FE/Qt: Runtime UI: Visual-mode machine-windows: Doxy.

Location:
trunk/src/VBox/Frontends/VirtualBox/src/runtime
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/VBox/Frontends/VirtualBox/src/runtime/fullscreen/UIMachineWindowFullscreen.h

    r57021 r57027  
    55
    66/*
    7  * Copyright (C) 2010-2013 Oracle Corporation
     7 * Copyright (C) 2010-2015 Oracle Corporation
    88 *
    99 * This file is part of VirtualBox Open Source Edition (OSE), as
     
    1616 */
    1717
    18 #ifndef __UIMachineWindowFullscreen_h__
    19 #define __UIMachineWindowFullscreen_h__
     18#ifndef ___UIMachineWindowFullscreen_h___
     19#define ___UIMachineWindowFullscreen_h___
    2020
    21 /* Local includes: */
     21/* GUI includes: */
    2222#include "UIMachineWindow.h"
    2323
     
    2727#endif /* Q_WS_WIN || Q_WS_X11 */
    2828
    29 /* Fullscreen machine-window implementation: */
     29/** UIMachineWindow reimplementation,
     30  * providing GUI with machine-window for the full-screen mode. */
    3031class UIMachineWindowFullscreen : public UIMachineWindow
    3132{
     
    4849protected:
    4950
    50     /* Constructor: */
     51    /** Constructor, passes @a pMachineLogic and @a uScreenId to the UIMachineWindow constructor. */
    5152    UIMachineWindowFullscreen(UIMachineLogic *pMachineLogic, ulong uScreenId);
    5253
     
    6162
    6263#if defined(Q_WS_WIN) || defined(Q_WS_X11)
    63     /* Session event-handlers: */
     64    /** Handles machine state change event. */
    6465    void sltMachineStateChanged();
    6566
     
    7778private:
    7879
    79     /* Prepare helpers: */
     80    /** Prepare visual-state routine. */
    8081    void prepareVisualState();
    8182#if defined(Q_WS_WIN) || defined(Q_WS_X11)
     83    /** Prepare mini-toolbar routine. */
    8284    void prepareMiniToolbar();
    8385#endif /* Q_WS_WIN || Q_WS_X11 */
    8486
    85     /* Cleanup helpers: */
    8687#if defined(Q_WS_WIN) || defined(Q_WS_X11)
     88    /** Cleanup mini-toolbar routine. */
    8789    void cleanupMiniToolbar();
    8890#endif /* Q_WS_WIN || Q_WS_X11 */
     91    /** Cleanup visual-state routine. */
    8992    void cleanupVisualState();
    9093
    91     /* Show stuff: */
     94    /** Updates geometry according to visual-state. */
    9295    void placeOnScreen();
     96    /** Updates visibility according to visual-state. */
    9397    void showInNecessaryMode();
    9498
     
    97101
    98102#if defined(Q_WS_WIN) || defined(Q_WS_X11)
    99     /* Update routines: */
     103    /** Common update routine. */
    100104    void updateAppearanceOf(int iElement);
    101105#endif /* Q_WS_WIN || Q_WS_X11 */
     
    113117#endif /* Q_WS_MAC */
    114118
    115     /* Factory support: */
     119    /** Factory support. */
    116120    friend class UIMachineWindow;
    117121};
    118122
    119 #endif // __UIMachineWindowFullscreen_h__
     123#endif /* !___UIMachineWindowFullscreen_h___ */
    120124
  • trunk/src/VBox/Frontends/VirtualBox/src/runtime/normal/UIMachineWindowNormal.h

    r55401 r57027  
    55
    66/*
    7  * Copyright (C) 2010-2012 Oracle Corporation
     7 * Copyright (C) 2010-2015 Oracle Corporation
    88 *
    99 * This file is part of VirtualBox Open Source Edition (OSE), as
     
    1616 */
    1717
    18 #ifndef __UIMachineWindowNormal_h__
    19 #define __UIMachineWindowNormal_h__
     18#ifndef ___UIMachineWindowNormal_h___
     19#define ___UIMachineWindowNormal_h___
    2020
    21 /* Local includes: */
     21/* GUI includes: */
    2222#include "UIMachineWindow.h"
    2323
     
    2626class UIIndicatorsPool;
    2727
    28 /* Normal machine-window implementation: */
     28/** UIMachineWindow reimplementation,
     29  * providing GUI with machine-window for the normal mode. */
    2930class UIMachineWindowNormal : public UIMachineWindow
    3031{
     
    3839protected:
    3940
    40     /* Constructor: */
     41    /** Constructor, passes @a pMachineLogic and @a uScreenId to the UIMachineWindow constructor. */
    4142    UIMachineWindowNormal(UIMachineLogic *pMachineLogic, ulong uScreenId);
    4243
     
    4849#endif /* Q_WS_X11 */
    4950
    50     /* Session event-handlers: */
     51    /** Handles machine state change event. */
    5152    void sltMachineStateChanged();
     53    /** Handles medium change event. */
    5254    void sltMediumChange(const CMediumAttachment &attachment);
     55    /** Handles USB controller change event. */
    5356    void sltUSBControllerChange();
     57    /** Handles USB device state change event. */
    5458    void sltUSBDeviceStateChange();
     59    /** Handles network adapter change event. */
    5560    void sltNetworkAdapterChange();
     61    /** Handles shared folder change event. */
    5662    void sltSharedFolderChange();
     63    /** Handles video capture change event. */
    5764    void sltVideoCaptureChange();
     65    /** Handles CPU execution cap change event. */
    5866    void sltCPUExecutionCapChange();
    5967
     
    7482private:
    7583
    76     /* Prepare helpers: */
     84    /** Prepare session connections routine. */
    7785    void prepareSessionConnections();
    7886#ifndef Q_WS_MAC
     87    /** Prepare menu routine. */
    7988    void prepareMenu();
    8089#endif /* !Q_WS_MAC */
     90    /** Prepare status-bar routine. */
    8191    void prepareStatusBar();
     92    /** Prepare visual-state routine. */
    8293    void prepareVisualState();
     94    /** Load settings routine. */
    8395    void loadSettings();
    8496
    85     /* Cleanup helpers: */
     97    /** Save settings routine. */
    8698    void saveSettings();
    87     //coid cleanupVisualState() {}
    88     //void cleanupStatusBar() {}
    89 #ifndef Q_WS_MAC
    90     //void cleanupMenu() {}
    91 #endif /* !Q_WS_MAC */
    92     //void cleanupConsoleConnections() {}
    9399
    94     /* Show stuff: */
     100    /** Updates visibility according to visual-state. */
    95101    void showInNecessaryMode();
    96102
    97     /* Helper: Machine-window geometry stuff: */
     103    /** Normalizes geometry according to guest-size. */
    98104    void normalizeGeometry(bool fAdjustPosition);
    99105
    100     /* Update stuff: */
     106    /** Common update routine. */
    101107    void updateAppearanceOf(int aElement);
    102108
     
    106112#endif /* !Q_WS_MAC */
    107113
    108     /* Event handler: */
     114    /** Common @a pEvent handler. */
    109115    bool event(QEvent *pEvent);
    110116
    111     /* Helpers: */
     117    /** Returns whether this window is maximized. */
    112118    bool isMaximizedChecked();
    113119
     
    115121    UIIndicatorsPool *m_pIndicatorsPool;
    116122
    117     /** Holds current window geometry. */
     123    /** Holds the current window geometry. */
    118124    QRect m_normalGeometry;
    119125
    120     /* Factory support: */
     126    /** Factory support. */
    121127    friend class UIMachineWindow;
    122128};
    123129
    124 #endif // __UIMachineWindowNormal_h__
     130#endif /* !___UIMachineWindowNormal_h___ */
    125131
  • trunk/src/VBox/Frontends/VirtualBox/src/runtime/scale/UIMachineWindowScale.h

    r55401 r57027  
    55
    66/*
    7  * Copyright (C) 2010-2012 Oracle Corporation
     7 * Copyright (C) 2010-2015 Oracle Corporation
    88 *
    99 * This file is part of VirtualBox Open Source Edition (OSE), as
     
    1616 */
    1717
    18 #ifndef __UIMachineWindowScale_h__
    19 #define __UIMachineWindowScale_h__
     18#ifndef ___UIMachineWindowScale_h___
     19#define ___UIMachineWindowScale_h___
    2020
    21 /* Local includes: */
     21/* GUI includes: */
    2222#include "UIMachineWindow.h"
    2323
    24 /* Scale machine-window implementation: */
     24/** UIMachineWindow reimplementation,
     25  * providing GUI with machine-window for the scale mode. */
    2526class UIMachineWindowScale : public UIMachineWindow
    2627{
     
    2930protected:
    3031
    31     /* Constructor: */
     32    /** Constructor, passes @a pMachineLogic and @a uScreenId to the UIMachineWindow constructor. */
    3233    UIMachineWindowScale(UIMachineLogic *pMachineLogic, ulong uScreenId);
    3334
    3435private:
    3536
    36     /* Prepare helpers: */
     37    /** Prepare main-layout routine. */
    3738    void prepareMainLayout();
    3839#ifdef Q_WS_MAC
     40    /** Prepare visual-state routine. */
    3941    void prepareVisualState();
    4042#endif /* Q_WS_MAC */
     43    /** Load settings routine. */
    4144    void loadSettings();
    4245
    43     /* Cleanup helpers: */
     46    /** Save settings routine. */
    4447    void saveSettings();
    45 #ifdef Q_WS_MAC
    46     //void cleanupVisualState() {}
    47 #endif /* Q_WS_MAC */
    48     //void cleanupMainLayout() {}
    4948
    50     /* Show stuff: */
     49    /** Updates visibility according to visual-state. */
    5150    void showInNecessaryMode();
    5251
    53     /* Event handlers: */
     52    /** Common @a pEvent handler. */
    5453    bool event(QEvent *pEvent);
    5554#ifdef Q_WS_WIN
     55    /** Windows: Common native @a pEvent handler. */
    5656    bool winEvent(MSG *pMessage, long *pResult);
    5757#endif /* Q_WS_WIN */
    5858
    59     /* Helpers: */
     59    /** Returns whether this window is maximized. */
    6060    bool isMaximizedChecked();
    6161
    62     /* Variables: */
     62    /** Holds the current window geometry. */
    6363    QRect m_normalGeometry;
    6464
    65     /* Factory support: */
     65    /** Factory support. */
    6666    friend class UIMachineWindow;
    6767};
    6868
    69 #endif // __UIMachineWindowScale_h__
     69#endif /* !___UIMachineWindowScale_h___ */
    7070
  • trunk/src/VBox/Frontends/VirtualBox/src/runtime/seamless/UIMachineWindowSeamless.h

    r57021 r57027  
    55
    66/*
    7  * Copyright (C) 2010-2013 Oracle Corporation
     7 * Copyright (C) 2010-2015 Oracle Corporation
    88 *
    99 * This file is part of VirtualBox Open Source Edition (OSE), as
     
    1616 */
    1717
    18 #ifndef __UIMachineWindowSeamless_h__
    19 #define __UIMachineWindowSeamless_h__
     18#ifndef ___UIMachineWindowSeamless_h___
     19#define ___UIMachineWindowSeamless_h___
    2020
    21 /* Local includes: */
     21/* GUI includes: */
    2222#include "UIMachineWindow.h"
    2323
     
    2727#endif /* Q_WS_WIN || Q_WS_X11 */
    2828
    29 /* Seamless machine-window implementation: */
     29/** UIMachineWindow reimplementation,
     30  * providing GUI with machine-window for the seamless mode. */
    3031class UIMachineWindowSeamless : public UIMachineWindow
    3132{
     
    3435protected:
    3536
    36     /* Constructor: */
     37    /** Constructor, passes @a pMachineLogic and @a uScreenId to the UIMachineWindow constructor. */
    3738    UIMachineWindowSeamless(UIMachineLogic *pMachineLogic, ulong uScreenId);
    3839
     
    4041
    4142#if defined(Q_WS_WIN) || defined(Q_WS_X11)
    42     /* Session event-handlers: */
     43    /** Handles machine state change event. */
    4344    void sltMachineStateChanged();
    4445
     
    4950private:
    5051
    51     /* Prepare helpers: */
     52    /** Prepare visual-state routine. */
    5253    void prepareVisualState();
    5354#if defined(Q_WS_WIN) || defined(Q_WS_X11)
     55    /** Prepare mini-toolbar routine. */
    5456    void prepareMiniToolbar();
    5557#endif /* Q_WS_WIN || Q_WS_X11 */
    5658
    57     /* Cleanup helpers: */
    5859#if defined(Q_WS_WIN) || defined(Q_WS_X11)
     60    /** Cleanup mini-toolbar routine. */
    5961    void cleanupMiniToolbar();
    6062#endif /* Q_WS_WIN || Q_WS_X11 */
     63    /** Cleanup visual-state routine. */
    6164    void cleanupVisualState();
    6265
    63     /* Show stuff: */
     66    /** Updates geometry according to visual-state. */
    6467    void placeOnScreen();
     68    /** Updates visibility according to visual-state. */
    6569    void showInNecessaryMode();
    6670
     
    6973
    7074#if defined(Q_WS_WIN) || defined(Q_WS_X11)
    71     /* Update routines: */
     75    /** Common update routine. */
    7276    void updateAppearanceOf(int iElement);
    7377#endif /* Q_WS_WIN || Q_WS_X11 */
    7478
    7579#if defined(VBOX_WITH_TRANSLUCENT_SEAMLESS) && defined(Q_WS_WIN)
    76     /* Handler: Translucency stuff: */
     80    /** Windows: Translucency stuff workaround. */
    7781    void showEvent(QShowEvent *pEvent);
    7882#endif /* VBOX_WITH_TRANSLUCENT_SEAMLESS && Q_WS_WIN */
     
    9599#endif /* VBOX_WITH_MASKED_SEAMLESS */
    96100
    97     /* Factory support: */
     101    /** Factory support. */
    98102    friend class UIMachineWindow;
    99103};
    100104
    101 #endif // __UIMachineWindowSeamless_h__
     105#endif /* !___UIMachineWindowSeamless_h___ */
    102106
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette